Skip to content

Contributing

Code conventions

This project strives to abide by the Open FUN Python coding standard. We use black as a code formatter.

TODO

MOVE all of this to some kind of DEVELOP.md

Set-up

Install python3.

Install pipx and then use it to install gitlint and pre-commit:

Text Only
``` bash
pipx install pre-commit
pipx install gitlint --include-deps
pipx inject gitlint requests (1)

1. We need the `requests` package in the gitlint venv
for the custom Gitmoji validator.
```

Follow the provided link to configure gitlint to be run with the pre-commit git hooks.

Install the pre-commit hooks:

Text Only
``` bash
pre-commit install
gitlint install-hook
```

VSCode