diff options
| -rw-r--r-- | CONTRIBUTING.md | 46 | ||||
| -rw-r--r-- | README.md | 40 |
2 files changed, 50 insertions, 36 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..c21d898 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,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. + @@ -7,43 +7,11 @@ Designed to run experimental hardware and data analysis with python. The package `qolab` was started in April 2021 by Eugeniy E. Mikhailov within Quantum Optics Lab (QOLab), which explains it name. +## Installation -## Developing - -### 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. +~~~~ +pip install qolab +~~~~ ## Build instructions |