kuryr-kubernetes/CONTRIBUTING.rst
Antoni Segura Puimedon 402a041b13 Add support for pre-commit-hooks
This will help forgetful developers like me not to miss running tox -e
pep8 before commiting.

Change-Id: Ied40f0daa59d9de34867c7b0cc4897a9332a7413
Signed-off-by: Antoni Segura Puimedon <celebdor@gmail.com>
2018-09-27 13:05:43 +02:00

964 B

If you would like to contribute to the development of OpenStack, you must follow the steps in this page:

https://docs.openstack.org/infra/manual/developers.html

If you already have a good understanding of how the system works and your OpenStack accounts are set up, you can skip to the development workflow section of this documentation to learn how changes to OpenStack should be submitted for review via the Gerrit tool:

https://docs.openstack.org/infra/manual/developers.html#development-workflow

Pull requests submitted through GitHub will be ignored.

Bugs should be filed on Launchpad, not GitHub:

https://bugs.launchpad.net/kuryr-kubernetes

If you want to have your code checked for pep8 automatically before commiting changes, you can just do:

pip install pre-commit
pre-commit install

From that moment on, every time you run git commit it will first check your diff for pep8 compliance and refuse to commit if it doesn't pass.