Contributing

Development install

You need to install the latest version of poetry >= 1.2.0 and pre-commit before.

git clone https://github.com/mondeja/project-config
cd project-config
poetry install
pre-commit install
poetry self add poetry-exec-plugin

Test

poetry exec test
# or `poetry exec t`

Show coverage report

poetry exec test:show

End to end tests

poetry exec test:e2e

Lint

poetry exec lint

Build documentation

poetry exec doc
# or `poetry exec doc:show`

Release

You must have administrator permissions on the repository.

version="$(poetry run bump <major/minor/patch>)"
git add .
git commit -m "Bump version"
git push origin master
git tag -a "v$version"
git push origin "v$version"