Contributing

Contributions to Obiwan are more than welcome! Please follow these guidelines before filing a pull request:

• Please abide by PEP8 2 as much as possible in your code writing, add docstrings and tests in py/tests for each new functionality.

• Check your changes did not add too many code issues. Run prospector 1 in Root directory. This will be run by Codacy 3 after pushing to GitHub.

• Check Docker image compiles; see Building the Docker image.

• Check documentation compiles, with the expected result; see Documentation.

• Check all tests pass within the new Docker image; see Tests.

• Submit your pull request.

References

1

http://prospector.landscape.io/en/master/

2

https://www.python.org/dev/peps/pep-0008/

3

https://app.codacy.com/