1
0
mirror of https://github.com/vinta/awesome-python.git synced 2024-12-22 10:10:14 +00:00
awesome-python/CONTRIBUTING.md

21 lines
843 B
Markdown
Raw Normal View History

2014-07-31 03:35:04 +00:00
# Contributing
Your contributions are always welcome!
2021-07-25 07:02:36 +00:00
## Guidelines
2014-07-31 03:35:04 +00:00
2015-10-03 09:53:46 +00:00
* Add one link per Pull Request.
2019-05-25 10:00:45 +00:00
* Make sure the PR title is in the format of `Add project-name`.
* Write down the reason why the library is awesome.
2015-10-03 10:08:33 +00:00
* Add the link: `* [project-name](http://example.com/) - A short description ends with a period.`
* Keep descriptions concise and **short**.
2015-10-03 09:53:46 +00:00
* Add a section if needed.
* Add the section description.
* Add the section title to Table of Contents.
2019-05-25 10:22:07 +00:00
* Search previous Pull Requests or Issues before making a new one, as yours may be a duplicate.
2014-07-31 18:54:38 +00:00
* Don't mention `Python` in the description as it's implied.
* Check your spelling and grammar.
2015-10-03 09:53:46 +00:00
* Remove any trailing whitespace.
2019-05-25 10:00:45 +00:00
2020-06-25 01:33:24 +00:00
Just a gentle reminder: **Try not to submit your own project. Instead, wait for someone finds it useful and submits it for you.**