1
0
Fork 0
mirror of https://github.com/Solido/awesome-flutter.git synced 2024-11-20 11:27:07 -05:00
flutter/contributing.md

42 lines
2.1 KiB
Dart
Raw Normal View History

2017-05-10 15:14:12 -04:00
# Contribution Guidelines
2018-01-27 16:19:37 -05:00
Please note that this project is released with a [Contributor Code of Conduct](https://github.com/spring-projects/spring-framework/blob/master/CODE_OF_CONDUCT.adoc). By participating in this project you agree to abide by its terms.
2017-05-10 15:14:12 -04:00
2018-09-26 11:28:40 -04:00
- Use a meaningful name to your commit or I'll close it instantly
2018-06-11 08:45:43 -04:00
- Do not commit on README, use SOURCE.md !
2018-09-26 11:30:00 -04:00
- Flutter is all about UI, use screenshots and animated media for your widget
2018-09-28 10:34:39 -04:00
- Paid solutions will be added if they offer free plan for open source or limited features for personnal devs but not limited in time. Fair is fair.
2017-05-10 15:14:12 -04:00
2018-09-27 16:21:51 -04:00
When your contribution is accepted you can add the Awesome Flutter Badge to your repository
thus signaling the quality of your work and linking to others authors Awesome projets
<a href="https://stackoverflow.com/questions/tagged/flutter?sort=votes">
<img alt="Awesome Flutter" src="https://img.shields.io/badge/Awesome-Flutter-blue.svg?longCache=true&style=flat-square" />
</a>
2018-09-27 16:23:19 -04:00
```
<a href="https://stackoverflow.com/questions/tagged/flutter?sort=votes">
<img alt="Awesome Flutter" src="https://img.shields.io/badge/Awesome-Flutter-blue.svg?longCache=true&style=flat-square" />
</a>
```
2018-09-27 16:21:51 -04:00
2017-05-10 15:14:12 -04:00
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.
2018-06-11 08:45:43 -04:00
- Use the following format: `[resource](link) - Description by [Author](link to author)`
2017-05-10 15:14:12 -04:00
- 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.
- Keep descriptions short and simple, but descriptive.
- Don't mention `Quantified Self` in the description as it's implied.
2018-06-11 08:45:43 -04:00
- Start the description with a capital.
2017-05-10 15:14:12 -04:00
- Check your spelling and grammar.
- Make sure your text editor is set to remove trailing whitespace.
Thank you for your suggestions!