1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
|
# 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?
1) Go to the *Issues* tab and click on the *New issue* button.
2) Title should be a small sentence describing the request.
3) The comment should contain 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
1) Create a new branch based on `develop` branch.
2) Fetch all dev dependencies.
* Install required python modules using `pip`: **python -m pip install .[testing]**
3) Ensure tests are ok by running them using [`pytest`](https://doc.pytest.org/en/latest/index.html).
4) Add your changes.
5) Follow [Black](https://black.readthedocs.io/en/stable/) code formatting.
* Install [pre-commit](https://pre-commit.com) python module using `pip`: **python -m pip install pre-commit**
* To add the [pre-commit](https://pre-commit.com) hook, after the installation run: **pre-commit install**
6) Add at least one [`pytest`](https://doc.pytest.org/en/latest/index.html) test case.
* Unless it is an internal refactoring request or a documentation update.
7) Add related [changelog entry](https://keepachangelog.com/en/1.1.0/) in the `Unreleased` section.
* Unless it is a documentation update.
#### Enter pull request
1) Go to the *Pull requests* tab and click on the *New pull request* button.
2) *base* should always be set to `develop` and it should be compared to your branch.
3) Title should be a small sentence describing the request.
4) 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)
|
