How to contribute

The Gatekeeper is currently in active development and welcomes code improvements, bug fixes, suggestions and feature requests. For those of your interested, providing documentation to other parties is equally welcome.

Open a pull request for the source:

$ git@github.com:otto-de/gatekeeper.git

Note

All code contributions should have adequate tests. If you add something, please add a test to our test-suite.

To run the tests simply run the following command from the root directory:

$ ./run-tests.sh

Style

If you decide to contribute code please follow naming conventions and style guides the code currently complies too.

In doubt: be safe and follow PEP-8.

Documentation

Contributing to documentation is as simple as editing the specified file in the docs directory of the source. We welcome all code improvements.

We use Sphinx for building our documentation. That can be obtained here.

Note

To view the docs as html, use the Makefile includes in the /docs directory. Simply run the following command:

$ make html

Reporting Issues

This is most important of all, if there are issues please let us know. Ony then can we improve the Gatekeeper.