2013-08-03 19:39:15 +02:00
|
|
|
# How To Contribute
|
|
|
|
|
|
|
|
|
|
sigal is always open for suggestions and contributions by generous developers.
|
|
|
|
|
Here are a few tipps to get you started.
|
|
|
|
|
|
|
|
|
|
Please:
|
|
|
|
|
|
|
|
|
|
- Obey [PEP 8] and [PEP 257].
|
|
|
|
|
- *Always* add tests and docs for your code.
|
2013-08-07 23:19:01 +02:00
|
|
|
- Add yourself to the AUTHORS file in an alphabetical fashion, and add your
|
|
|
|
|
name to the license header of the files you modify.
|
2013-08-03 19:39:15 +02:00
|
|
|
- Write [good commit messages].
|
|
|
|
|
- Ideally, [squash] your commits, i.e. make your pull requests just one commit.
|
|
|
|
|
|
|
|
|
|
Thank you for considering to contribute to sigal !
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
[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
|
