Appendix D. Contribution rules
|Copyright:||© 2011-2012, Kwpolska.|
|License:||BSD (see /LICENSE or :doc:`Appendix B <LICENSE>`.)|
Do you want to contribute to this project? Great! I’d love to see some help, but you need to comply with some easy rules.
GitHub Issues are the best way to report an issue. If you do not have an account there, get one or mail me.
When pasting console sessions, please paste them fully, prompt-to-prompt, to see all the messages and your input. Trim only stuff that you are 1000% sure that is not related to the project in question.
Pythonista? Great! There are a few things you need to do first.
- A GitHub account is mandatory. Period. Patches by mail are not accepted. Sorry.
- Fork the repo and work on it.
And these are the rules used while writing code or commiting:
- PEP 8. pip install pep8 may help you.
- Commits should be logical. Signoffs and long messages are welcome. “fixes #xxx” is mandatory if an issue exists.
Done? Go hit the Pull Request button over on GitHub! Your commit should be pulled up in the next few moments.
The ones who want to localize, look at the localization guide, also part of the documentation.