56 lines (42 loc) · 1.91 KB

How to contribute

Everyone is free to contribute on this project.

There are two ways to contribute:

Submitting an issue

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

Title should be a small sentence describing the request.

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 dependencies using pip.
```
python -m pip install .[testing]
```
Ensure tests are ok by running them using pytest.
```
pytest
```
Install pre-commit hook to ensure new code will follow guidelines.
```
python -m pip install pre-commit
pre-commit install
```
Add your changes.
Add at least one pytest test case.
- Unless it is an internal refactoring request or a documentation update.
Add related changelog entry in the Unreleased section.
- Unless it is a documentation update.

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 contain 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)