It might be that we are already working on the same or similar feature, but we haven’t made our work visible yet.
Create a Development Environment¶
We usually develop in a virtual environment. To create one, change to the root directory of the repository and invoke:
python -m venv venv
You need to activate it. On nix (Linux, Mac, *etc.):
and on Windows:
Install Development Dependencies¶
Once you activated the virtual environment, you can install the development
pip3 install --editable .[dev]
We provide a battery of pre-commit checks to make the code uniform and consistent across the code base.
We use black to format the code and use the default maximum line length of 88 characters.
To run all pre-commit checks, run from the root directory:
pre-commit run --all-files
The pre-commit hooks also run as part of our continuous integration pipeline.
Write Commit Message¶
We follow Chris Beams’ guidelines on commit messages:
Separate subject from body with a blank line
Limit the subject line to 50 characters
Capitalize the subject line
Do not end the subject line with a period
Use the imperative mood in the subject line
Wrap the body at 72 characters
Use the body to explain what and why vs. how
In order of inital commit. Many thanks!