1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
|
How To Contribute
=================
Although very small, “first” is always open for suggestions and contributions
by generous developers. I’ve collected a few tipps to get you started.
Please:
- Obey `PEP 8`_ and `PEP 257`_.
- *Always* add tests and docs for your code.
- Add yourself to the AUTHORS.rst_ file in an alphabetical fashion.
- Write `good commit messages`_.
- Ideally, squash_ your commits, i.e. make your pull requests just one commit.
Thank you for considering to contribute to “first”!
.. _`squash`: http://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html
.. _`PEP 8`: http://www.python.org/dev/peps/pep-0008/
.. _`PEP 257`: http://www.python.org/dev/peps/pep-0257/
.. _`good commit messages`: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
.. _`AUTHORS.rst`: https://github.com/hynek/first/blob/master/AUTHORS.rst
|
