Mirrored_Repos/AppFlowy
1
0
Fork 0
mirror of https://github.com/AppFlowy-IO/AppFlowy.git synced 2024-08-30 18:12:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update CONTRIBUTING.md v2

Browse Source
This commit is contained in:
Annie 2021-11-09 11:12:30 +08:00 committed by GitHub
parent e697a6d33b
commit 4477169442
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 29 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

58
doc/CONTRIBUTING.md
View File

@ -5,7 +5,6 @@ Hello, and welcome! Whether you are trying to report a bug, proposing a feature
Consult the Table of Contents below, and jump to the desired section.
## Table of Contents
- [Sign the CLA Agreement](#sign-the-cla-agreement)
- [Contributing](#contributing)
- [Non-coded Contributions](#non-coded-contributions)
- [Coding Contributions](#coding-contributions)
@ -16,13 +15,7 @@ Consult the Table of Contents below, and jump to the desired section.
- [Sponsor](#sponsor)
- [Contributor T-shirt](#contributor-t-shirt)
- [Code of Conduct](#code-of-conduct)
## Sign the CLA Agreement
TODO
TODO
[Back to TOC](#table-of-contents)
- [Sign the CLA Agreement](#sign-the-cla-agreement)
## Contributing
@ -31,14 +24,14 @@ TODO
There can help in multiple ways - even if you don't write code, you can still give back your love to our community. Here are a few ideas:
- Answer questions having #general-help-wanted hashtags on the forum
- Improve the documentation (To-Do:documentation contribution)
- Submit feature requests on Github (link)
- Answer questions having ""General help wanted" labels on the [forum](https://github.com/AppFlowy-IO/appflowy/discussions)
- Improve the documentation (WIP)
- Submit feature requests on Github ([link](https://github.com/AppFlowy-IO/appflowy/issues))
- Submit an issue for feature requests. Please include the information listed below in the issue:
- 1~3 main use cases of the proposed feature
- what types of users can benefit from using your proposed feature
- Submit a patch to fix the issue [see this section](#submit-a-patch)
- Report bugs on Github (link). Please include relevant information listed below in the ticket:
- Report bugs on Github ([link](https://github.com/AppFlowy-IO/appflowy/issues)). Please include relevant information listed below in the ticket:
- A summary of the issue
- A list of steps to reproduce the issue
- The version of AppFlowy you encountered the issue with
@ -48,17 +41,16 @@ There can help in multiple ways - even if you don't write code, you can still gi
- Spread the word on the media to get more people to join the community. To name a few channels, Product Hunt, Hacker Noon, Quora, Reddit, and Stack Overflow are good choices.
- Give a lightning talk at your local hackerspace on why you love AppFlowy
- Write a review of the pros and cons of similar open source apps
- Really want a fix or feature? Post bounty here (link). Here are great opportunities to solve some community issues and earn some extra tips for coffee! Take a look at the current bounties (link) on Bountysource.
[Back to TOC](#table-of-contents)
- Really want a fix or feature? Contact annie@appflowy.io
### Coding Contributions
Developers who consider participating in AppFlowy's development, please go here to start:
#### Report a Bug
#### Report a Bug
Please include relevant information listed below in the ticket:
Please include relevant information listed below in the ticket ([link](https://github.com/AppFlowy-IO/appflowy/issues)):
- A summary of the issue
- A list of steps to reproduce the issue
- The version of AppFlowy you encountered the issue with
@ -66,20 +58,20 @@ Please include relevant information listed below in the ticket:
#### Helping Others
Helping other members of the community by answering questions having #technical-help-wanted or #general-help-wanted hashtags on the forum
Helping other members of the community by answering questions having "Technical help wanted" or "General help wanted" labels on the [forum](https://github.com/AppFlowy-IO/appflowy/discussions)
#### Submit a Patch
We love to receive Pull Requests.
- If you are a beginner or a newcomer, here are some tasks for you to get ramped up:
- Fix a typo in code
- Fix a typo in the documentation (see this section)
- Awesome issues for beginners or newcomers (link)
- Fix a typo in the documentation (WIP)
- Awesome issues for beginners or newcomers (WIP)
- Provide feedback on the proposed features (link)
- Review Pull Requests (link)
- If you are ready to code (maybe a lot), please submit a patch!
- (To Do: guidelines)
- (To Do: Code Style)
- (WIP: guidelines)
- (WIP: Code Style)
#### Tell Us
@ -87,26 +79,25 @@ Not feeling quite up to contributing? Tell us your suggestions!
- Submit feature requests ([see this section](#non-coded-contributions))
- Provide your suggestions on the forum (tag them with #general-suggestions)
- Review Pull Requests
- Provide feedback on the proposed features (link)
- Provide feedback on the proposed features ([link](https://github.com/AppFlowy-IO/appflowy/issues))
[Back to TOC](#table-of-contents)
### Sponsor
Sponsoring is another great way to contribute to the community. (To Do: Tiers)
- show love
- special perks
- paid contents / support
Sponsoring is another great way to contribute to the community.
- Buy us a coffee on [ko-fi](https://ko-fi.com/appflowy)
[Back to TOC](#table-of-contents)
## Contributor T-Shirt
If your Pull Request was accepted as it fixes a bug, adds functionality, or makes AppFlowy's codebase significantly easier to use or understand, congratulations! You are now an official contributor to AppFlowy. Get in touch with us (link) to receive the very special Contributor T-shirt!
If your Pull Request was accepted as it fixes a bug, adds functionality, or makes AppFlowy's codebase significantly easier to use or understand, congratulations! You are now an official contributor to AppFlowy. Get in touch with us ([link](https://tally.so/r/mKP5z3)) to receive the very special Contributor T-shirt!
If you get more people to know AppFlowy or uplift our community, congratulations! (To Do: Requirements) Get in touch with us (link) to receive the very special AppFlowy Ambassador T-shirt!
Proudly wear your T-shirt and show it to us by tagging @appflowy on Twitter
Proudly wear your T-shirt and show it to us by tagging ... on Twitter
[Back to TOC](#table-of-contents)
## Code of Conduct
@ -115,4 +106,13 @@ Please report a code of conduct violation to annie@appflowy.io
Let's encourage the behavior we want to see in the world and constantly foster a welcoming environment!
[Contributor Covenant](https://www.contributor-covenant.org/version/2/0/code_of_conduct/)
## Sign the CLA Agreement
That we do not have any potential problems later it is sadly necessary to sign a Contributor License Agreement. That can be done literally with the push of a button.
We used the most simple one that exists. It is from Indie Open Source which uses plain English and is literally only a few lines long.
A bot will automatically comment on the pull request once it got opened asking for the agreement to be signed. Before it did not get signed it is sadly not possible to merge it in.
[Back to TOC](#table-of-contents)