Contributing to Livestock

Contributing

• Create a account on Github, if you do not already have one.
• Submit an issue describing your proposed change.
• We will respond to your issue as quickly as possible.
• Fork Livestock, develop and test your code changes.
• Ensure that your code adheres to the existing style. Our style guide can be found below.
• Ensure that your code has an appropriate set of tests, which all pass.
• Submit your pull request!

Style Guide

We try to follow PEP8 and the Zen of Python as much as possible to make our code reader friendly. We differ from PEP8 in that we allow 120 characters long lines. (PyCharm default)

Pull Requests

We prefer shorter pull requests over longer (in terms of written lines of Python code). That makes it easier for us to review the pull request.

Please refer to your initial issue in the comments of the pull request.

Tests

Make sure that your change includes some tests. The pull request should contain some, so your change does not not break previous code.