We appreciate all contributions! If you are planning to contribute bug-fixes or documentation improvements, please go ahead and open a pull request (PR). If you are planning to contribute new features, please open an issue and discuss the feature with us first.
To start working on pystiche-papers clone the repository from GitHub and set up the
development environment
git clone https://github.com/pystiche/papers
cd papers
virtualenv .venv --prompt='(pystiche-papers-dev) '
source .venv/bin/activate
pip install doit
doit installEvery PR is subjected to multiple checks that it has to pass before it can be merged. The checks are performed through doit. Below you can find details and instructions how to run the checks locally.
pystiche-papers uses ufmt to format Python
code, and flake8 to enforce
PEP8 compliance.
Furthermore, pystiche-papers is PEP561
compliant and checks the type annotations with mypy .
To automatically format the code, run
doit formatInstead of running the formatting manually, you can also add pre-commit hooks. By running
pre-commit installonce, an equivalent of doit format is run everytime you git commit something.
Everything that cannot be fixed automatically, can be checked with
doit lintpystiche-papers uses pytest to run the test
suite. You can run it locally with
doit testTo build the documentation locally, run
doit doc