python-cueclient/doc/source/contributing.rst

1.1 KiB

Contributing

Code is hosted on GitHub. Submit bugs to the Cue Client project on Launchpad. Submit code to the openstack/python-cueclient project using Gerrit.

Here's a quick summary:

Install the git-review package to make life easier

pip install git-review

Branch, work, & submit:

# cut a new branch, tracking master
git checkout --track -b bug/id origin/master
# work work work
git add stuff
git commit
# rebase/squash to a single commit before submitting
git rebase -i
# submit
git-review

Coding Standards

Cue Client uses the OpenStack flake8 coding standards guidelines. These are stricter than pep8, and are run by gerrit on every commit.

You can use tox to check your code locally by running

# For just flake8 tests
tox -e flake8
# For tests + flake8
tox