23 lines
583 B
Markdown
23 lines
583 B
Markdown
# Contributing Guide
|
|
|
|
## <a name="commit-message-format"></a> Commit message format
|
|
We use [this](https://www.conventionalcommits.org/en/v1.0.0/) standard
|
|
```gitcommit
|
|
<type>(<scope>): <subject>
|
|
<BLANK LINE>
|
|
[optional body]
|
|
<BLANK LINE>
|
|
[optional footer]
|
|
```
|
|
|
|
## <a name="pre-commit"></a> Setting Up Pre-Commit Hooks
|
|
We use pre-commit to automatically enforce code quality checks before commits:
|
|
```sh
|
|
python3 -m venv venv
|
|
. ./venv/bin/activate
|
|
pip install pre-commit
|
|
pre-commit install
|
|
pre-commit install --hook-type commit-msg
|
|
```
|
|
Hooks will now run automatically on every commit.
|