2015-01-27 16:53:17 +00:00
|
|
|
|
How To Contribute
|
|
|
|
|
|
=================
|
|
|
|
|
|
|
|
|
|
|
|
Every open source project lives from the generous help by contributors that sacrifice their time and ``attrs`` is no different.
|
|
|
|
|
|
|
|
|
|
|
|
To make participation as pleasant as possible, this project adheres to the `Code of Conduct`_ by the Python Software Foundation.
|
|
|
|
|
|
|
|
|
|
|
|
Here are a few guidelines to get you started:
|
|
|
|
|
|
|
|
|
|
|
|
- Add yourself to the AUTHORS.rst_ file in an alphabetical fashion.
|
|
|
|
|
|
Every contribution is valuable and shall be credited.
|
|
|
|
|
|
- If your change is noteworthy, add an entry to the changelog_.
|
|
|
|
|
|
- No contribution is too small; please submit as many fixes for typos and grammar bloopers as you can!
|
2015-02-01 18:27:36 +00:00
|
|
|
|
- Don’t break `backward compatibility`_.
|
2015-01-27 16:53:17 +00:00
|
|
|
|
- *Always* add tests and docs for your code.
|
|
|
|
|
|
This is a hard rule; patches with missing tests or documentation won’t be merged.
|
|
|
|
|
|
If a feature is not tested or documented, it doesn’t exist.
|
|
|
|
|
|
- Obey `PEP 8`_ and `PEP 257`_.
|
|
|
|
|
|
- Write `good commit messages`_.
|
|
|
|
|
|
|
|
|
|
|
|
.. note::
|
|
|
|
|
|
If you have something great but aren’t sure whether it adheres -- or even can adhere -- to the rules above: **please submit a pull request anyway**!
|
|
|
|
|
|
|
|
|
|
|
|
In the best case, we can mold it into something, in the worst case the pull request gets politely closed.
|
|
|
|
|
|
There’s absolutely nothing to fear.
|
|
|
|
|
|
|
|
|
|
|
|
Thank you for considering to contribute to ``attrs``!
|
|
|
|
|
|
If you have any question or concerns, feel free to reach out to me.
|
|
|
|
|
|
|
|
|
|
|
|
|
2015-02-21 10:41:10 +00:00
|
|
|
|
.. _`PEP 8`: https://www.python.org/dev/peps/pep-0008/
|
|
|
|
|
|
.. _`PEP 257`: https://www.python.org/dev/peps/pep-0257/
|
2015-01-27 16:53:17 +00:00
|
|
|
|
.. _`good commit messages`: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
|
|
|
|
|
|
.. _`Code of Conduct`: https://www.python.org/psf/codeofconduct/
|
|
|
|
|
|
.. _changelog: https://github.com/hynek/attrs/blob/master/docs/changelog.rst
|
|
|
|
|
|
.. _AUTHORS.rst: https://github.com/hynek/attrs/blob/master/AUTHORS.rst
|
2015-02-01 18:27:36 +00:00
|
|
|
|
.. _`backward compatibility`: https://attrs.readthedocs.org/en/latest/backward-compatibility.html
|
