update the contribution guidelines

This commit is contained in:
Vinta 2015-10-03 17:53:46 +08:00
parent d68e4fd849
commit febfea37ad

View File

@ -4,12 +4,14 @@ Your contributions are always welcome!
## Guidelines ## Guidelines
* Add section if needed. * Add one link per Pull Request.
* Add section description. * Add the link: `* [project-name](http://example.com/) - A short description ends with a dot.`
* Add section title to Table of contents. * Keep descriptions concise.
* Add a section if needed.
* Add the section description.
* Add the section title to Table of Contents.
* Search previous suggestions before making a new one, as yours may be a duplicate. * Search previous suggestions before making a new one, as yours may be a duplicate.
* Add your links: `* [project-name](http://example.com/) - A short description ends with a dot.`
* Don't mention `Python` in the description as it's implied. * Don't mention `Python` in the description as it's implied.
* Check your spelling and grammar. * Check your spelling and grammar.
* Make sure your text editor is set to remove trailing whitespace. * Remove any trailing whitespace.
* Send a Pull Request. * Send a Pull Request with the reason why the library is awesome.