blob: c21d898fc6ebeda2952a728cde8e0618c9ff3a66 (
plain)
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
|
# Developers guide
Contributions are welcome.
## Running automatic checks
Make sure that `tox` command reports no issues after code
modification.
If you want to runc some checks manually see below.
## Formatting
Adhere to [black](https://pypi.org/project/black/)
formatting style and run modified files via `black`.
I.e. do `black fname` or even more extreme
~~~~~
black .
~~~~~
to reformat the whole project.
## Linting
I find [flake8](https://github.com/PyCQA/flake8/tree/main)
to be quite good linter.
Make sure that you check for linting errors all the files
and review the messages.
Before committing and especially pushing, run
~~~~~
flake8 --max-line-length=88
~~~~~
here we set maximum line length to `black` default, which
is a bit longer `python` recommended 79.
## Test instructions
Make sure that you run the test suite and no errors are triggered.
~~~~~
export PYTHONPATH=.
python -m pytest
~~~~~
Note that we cannot just run `pytest` since I see no way to set the module search path.
|
