How to contribute

Everyone is free to contribute on this project.

There are two ways to contribute:

Submit an issue.
Submit a pull request.

Submitting an issue

Before creating an issue please make sure that it was not already reported.

When?

You encountered an issue.
You have a change proposal.
You have a feature request.

How?

Go to the Issues tab and click on the New issue button.
Title should be a small sentence describing the request.
The comment should contains as much information as possible
- Actual behavior (including the version you used)
- Expected behavior
- Steps to reproduce

Submitting a pull request

When?

You fixed an issue.
You changed something.
You added a new feature.

How?

Code

Create a new branch based on develop branch.
Fetch all dev dependencies.
- Install required python modules using pip: python -m pip install .[testing]
Ensure tests are ok by running them using pytest.
Add your changes.
Follow Black code formatting.
- Install pre-commit python module using pip: python -m pip install pre-commit
- To add the pre-commit hook, after the installation run: pre-commit install
Add at least one pytest test case.
- Unless it is an internal refactoring request or a documentation update.
Increment version number and add related changelog entry.
- Unless it is a documentation update.

Changelog entry

Once the changelog entry is added, please don't forget to also add the link to the proper tag at the end of the changelog.

Enter pull request

Go to the Pull requests tab and click on the New pull request button.
base should always be set to develop and it should be compared to your branch.
Title should be a small sentence describing the request.
The comment should contains as much information as possible
- Actual behavior (before the new code)
- Expected behavior (with the new code)
- Steps to reproduce (with and without the new code to see the difference)