Skip to content

Latest commit

 

History

History
291 lines (201 loc) · 10.2 KB

CONTRIBUTING.rst

File metadata and controls

291 lines (201 loc) · 10.2 KB
Raw

Contributing

Welcome to 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.

If you are new to using git or have never collaborated in a project, please have a look at contribution-guide.org. Other resources are also listed in the guide created by FreeCodeCamp [1].

If you are new to working with Gerrit, please see our Gerrit Guide

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.

Issue Reports

If you experience bugs or general issues with gerrit_to_platform, please have a look on the issue tracker. If you don't see anything useful there, please feel free to fire an issue report.

Tip

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.

Documentation Improvements

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 code contribution.

When working on documentation changes in your local machine, you can compile them using tox:

tox -e docs

and use Python's built-in web server for a preview in your web browser (http://localhost:8000):

python3 -m http.server --directory 'docs/_build/html'

Code Contributions

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

Before you start coding, we recommend creating an isolated virtual environment to avoid any problems with your installed Python packages. Do this via either virtualenv:

virtualenv <PATH TO VENV>
source <PATH TO VENV>/bin/activate

or Miniconda:

conda create -n gerrit_to_platform python=3 six virtualenv pytest pytest-cov
conda activate gerrit_to_platform

Clone the repository

  1. Create an user account on Gerrit if you do not already have one.

  2. 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

  3. You should run:

    pip install -U pip setuptools -e .

    to be able to import the package under development in the Python REPL.

  4. Install pre-commit:

    pip install pre-commit && pre-commit install

    gerrit_to_platform comes with a lot of hooks configured to automatically help the developer to check the code during creation.

Create your changes

  1. Create a branch to hold your changes:

    git checkout -b my-feature

    and start making changes. Never work on the main branch!

  2. Start your work on this branch. Don't forget to add docstrings to new functions, modules and classes.

  3. Add yourself to the list of contributors in AUTHORS.rst.

  4. Add a reno note for changes if they are changelog worthy:

    tox -e reno new my_change_identifier

    and edit the returned file

  5. 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-commit and 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.

    Important

    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.

  6. Please check that your changes don't break any unit tests with:

    tox

    (after having installed tox with pip install tox or pipx).

    You can also use tox to run other pre-configured tasks in the repository. Try tox -av to see a list of the available checks.

Propose your contribution

  1. If everything works fine, push your local branch to Gerrit with:

    git review

  2. If your change requires updates follow the procedure for updating an existing patch

Troubleshooting

The following tips can are helpful when facing problems to build or test the package:

  1. Make sure to fetch all the tags from the upstream repository. The command git describe --abbrev=0 --tags should 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-info folders in the src folder or potentially in the root of your project.

  2. Sometimes tox misses out when adding new dependencies to pyproject.toml and docs/requirements.txt. If you find any problems with missing dependencies when running a command with tox, try to recreate the tox environment using the -r flag. For example, instead of:

    tox -e docs

    Try running:

    tox -r -e docs

  3. Make sure to have a reliable tox installation that uses the correct Python version (e.g., 3.7+). When in doubt you can run:

    tox --version
# OR
which tox

    If you have trouble and are seeing weird errors upon running tox, you can also try to create a dedicated virtual environment with a tox binary freshly installed. For example:

    virtualenv .venv
source .venv/bin/activate
.venv/bin/pip install tox
.venv/bin/tox -e all

  4. Pytest can drop you in an interactive session in the case an error occurs. To do that you need to pass a --pdb option (for example by running tox -- -k <NAME OF THE FALLING TEST> --pdb). You can also setup breakpoints manually instead of using the --pdb option.

Maintainer tasks

Releases

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 gerrit_to_platform:

  1. Make sure all unit tests are successful.
  2. Tag the current commit on the main branch with a signed release tag, e.g., git tag -sm 'v1.2.3' v1.2.3.
  3. Push the new tag to the origin repository, e.g., git push v1.2.3
  4. Clean up the dist and build folders with tox -e clean (or rm -rf dist build) to avoid confusion with old builds and Sphinx docs.
  5. Run tox -e build and check that the files in dist have the correct version (no .dirty or 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.
  6. Run tox -e publish -- --repository pypi and check that everything uploaded to PyPI.
[1]Even though, these resources focus on open source projects and communities, the general ideas behind collaborating with other developers to collectively create software are general and are applicable to all sorts of environments, including private companies and proprietary code bases.