-
Notifications
You must be signed in to change notification settings - Fork 24
How to contribute code to Devilry
Espen Angell Kristiansen edited this page May 29, 2015
·
4 revisions
- Fork the devilry sourcecode using the fork-button on github. Github has a nice guide.
- Make changes to your fork
- Make sure you fork is fully merged with the devilry sourcecode.
- Send a pull request to one of the developers using the pull request button on your fork.
If we consider your code stable and useful enough, we will merge it into the devilry sourcecode. It is important to understand that we might not accept your code (for various reasons), so you should probably message us your idea before you start coding. You should also be prepared to have to go a couple of rounds of reviews before we accept your code, especially if it is a big change.
We follow the official python guidelines for python code (PEP 8). Additional restrictions:
- Use spaces-only for indentation.
- Write tests. We do not accept new code into the repository without tests.
- Read How to write API documentation.
- https://github.com/devilry/devilry-django/pull/754 (This one is perfect, with tests and clean working code).
- https://github.com/devilry/devilry-django/pull/266 (Notice that this request required a bit of back and forth, but it was accepted after some adjustments)