gerrit_to_platform contributor’s guide.
This document focuses on getting any potential contributor familiarized with the development processes, but other kinds of contributions are also appreciated.
Please notice, we expect all users and contributors to be open, considerate, reasonable, and respectful. When in doubt, Python Software Foundation’s Code of Conduct is a good reference on terms of behavior guidelines.
If you experience bugs or general issues with
have a look on the issue tracker. If you don’t see anything useful there,
please feel free to fire an issue report.
Please don’t forget to include the closed issues in your search. Sometimes a solution was already reported, and the problem now considered solved.
New issue reports should include information about your programming environment (e.g., operating system, Python version) and steps to reproduce the problem. Please try also to simplify the reproduction steps to a minimal example that still illustrates the problem you are facing. By removing other factors, you help us to identify the root cause of the issue.
You can help improve
gerrit_to_platform docs by making them more readable
and coherent, or by adding missing information and correcting mistakes.
gerrit_to_platform documentation uses Sphinx as its main documentation
compiler. This means that the docs are in the same repository as the project
code, and that any documentation update has code review in the same way as a
When working on documentation changes in your local machine, you can
compile them using
tox -e docs
and use Python’s built-in web server for a preview in your web browser
python3 -m http.server --directory 'docs/_build/html'
Test-Drive Development is the driving method of development of this code base. All contributions must come with supporting test cases.
Submit an issue¶
Before you work on any non-trivial code contribution it’s best to first create a report in the issue tracker to start a discussion on the subject. This often provides considerations and avoids unnecessary work.
Create an environment¶
virtualenv <PATH TO VENV> source <PATH TO VENV>/bin/activate
conda create -n gerrit_to_platform python=3 six virtualenv pytest pytest-cov conda activate gerrit_to_platform
Clone the repository¶
Create an user account on Gerrit if you do not already have one.
Clone this copy to your local disk:
git clone ssh://YourLogin@gerrit.linuxfoundation.org:29413/releng/gerrit_to_platform.git cd gerrit_to_platform git review -s
You should run:
pip install -U pip setuptools -e .
to be able to import the package under development in the Python REPL.
pip install pre-commit && pre-commit install
gerrit_to_platformcomes with a lot of hooks configured to automatically help the developer to check the code during creation.
Create your changes¶
Create a branch to hold your changes:
git checkout -b my-feature
and start making changes. Never work on the main branch!
Start your work on this branch. Don’t forget to add docstrings to new functions, modules and classes.
Add yourself to the list of contributors in
Add a reno note for changes if they are changelog worthy:
tox -e reno new my_change_identifier
and edit the returned file
When you’re done editing, do:
git add <MODIFIED FILES> git commit
to record your changes in git.
Please make sure to see the validation messages from
pre-commitand fix any eventual issues. This should automatically use flake8/black to check/fix the code style in a way that is compatible with the project.
Don’t forget to add unit tests and documentation in case your contribution adds a feature and is not a bugfix.
Moreover, writing a descriptive commit message is highly recommended. In case of doubt, you can check the commit history with:
git log --graph --decorate --pretty=oneline --abbrev-commit --all
to look for recurring communication patterns.
Please check that your changes don’t break any unit tests with:
(after having installed
pip install toxor
You can also use
toxto run other pre-configured tasks in the repository. Try
tox -avto see a list of the available checks.
Propose your contribution¶
If everything works fine, push your local branch to Gerrit with:
If your change requires updates follow the procedure for updating an existing patch
The following tips can are helpful when facing problems to build or test the package:
Make sure to fetch all the tags from the upstream repository. The command
git describe --abbrev=0 --tagsshould return the version you are expecting. If you are trying to run CI scripts in a fork repository, make sure to push all the tags. You can also try to remove all the egg files or the complete egg folder, i.e.,
.eggs, as well as the
*.egg-infofolders in the
srcfolder or potentially in the root of your project.
toxmisses out when adding new dependencies to
docs/requirements.txt. If you find any problems with missing dependencies when running a command with
tox, try to recreate the
toxenvironment using the
-rflag. For example, instead of:
tox -e docs
tox -r -e docs
Make sure to have a reliable
toxinstallation that uses the correct Python version (e.g., 3.7+). When in doubt you can run:
tox --version # OR which tox
virtualenv .venv source .venv/bin/activate .venv/bin/pip install tox .venv/bin/tox -e all
Pytest can drop you in an interactive session in the case an error occurs. To do that you need to pass a
--pdboption (for example by running
tox -- -k <NAME OF THE FALLING TEST> --pdb). You can also setup breakpoints manually instead of using the
If you are part of the group of maintainers and have correct user permissions
on PyPI, the following steps can release a new version for
Make sure all unit tests are successful.
Tag the current commit on the main branch with a signed release tag, e.g.,
git tag -sm 'v1.2.3' v1.2.3.
Push the new tag to the origin repository, e.g.,
git push v1.2.3
Clean up the
tox -e clean(or
rm -rf dist build) to avoid confusion with old builds and Sphinx docs.
tox -e buildand check that the files in
disthave the correct version (no
.dirtyor git hash) according to the git tag. Also check the sizes of the distributions, if they are too big (e.g., > 500KB). Verify that there is no unwanted clutter.
tox -e publish -- --repository pypiand check that everything uploaded to PyPI.