mirror of
https://github.com/Solido/awesome-flutter.git
synced 2024-11-20 11:27:07 -05:00
29 lines
1.6 KiB
Markdown
29 lines
1.6 KiB
Markdown
|
# Contribution Guidelines
|
||
|
|
|
||
|
|
Please note that this project is released with a [Contributor Code of Conduct](code-of-conduct.md). By participating in this project you agree to abide by its terms.
|
||
|
|
|
||
|
|
-
|
||
|
|
|
||
|
|
Ensure your pull request adheres to the following guidelines:
|
||
|
|
|
||
|
|
- Search previous suggestions before making a new one, as yours may be a duplicate.
|
||
|
|
- Suggested packages should be tested and documented.
|
||
|
|
- The pull request should have a meaningful title and include a link to the package / resource and why it's awesome.
|
||
|
|
- Make an individual pull request for each suggestion.
|
||
|
|
- Use the following format: `[resource](link) - Description.`
|
||
|
|
- Use [title-casing](http://titlecapitalization.com) (AP style).
|
||
|
|
- Additions should be added to the bottom of the relevant category.
|
||
|
|
- New categories, or improvements to the existing categorization are welcome.
|
||
|
|
- Link to the GitHub repo, not npmjs.com.
|
||
|
|
- Keep descriptions short and simple, but descriptive.
|
||
|
|
- Don't mention `Quantified Self` in the description as it's implied.
|
||
|
|
- Start the description with a capital and end with a full stop/period.
|
||
|
|
- Check your spelling and grammar.
|
||
|
|
- Make sure your text editor is set to remove trailing whitespace.
|
||
|
|
|
||
|
|
Thank you for your suggestions!
|
||
|
|
|
||
|
|
### Updating your PR
|
||
|
|
|
||
|
|
A lot of times, making a PR adhere to the standards above can be difficult. If the maintainers notice anything that we'd like changed, we'll ask you to edit your PR before we merge it. If you're not sure how to do that, [here is a guide](https://github.com/RichardLitt/docs/blob/master/amending-a-commit-guide.md) on the different ways you can update your PR so that we can merge it.
|