added example precommit hook to the README

This commit is contained in:
Tobias Diekershoff 2023-01-07 13:36:23 +01:00
parent 1fd8645de8
commit 47c3c61e50

View file

@ -42,6 +42,13 @@ This project uses [REUSE](https://reuse.software/) to ensure that all components
are release under a FLOSS compatible license. If you contribute to the project, are release under a FLOSS compatible license. If you contribute to the project,
please ensure that your contribution is REUSE compliant. please ensure that your contribution is REUSE compliant.
This can be done by adding the following to your `.git/hooks/pre-commit` hook.
``` shell
#!/usr/bin/env bash
reuse lint
```
## Credits ## Credits
`brewserverblocklist` was created with [`cookiecutter`](https://cookiecutter.readthedocs.io/en/latest/) and the `py-pkgs-cookiecutter` [template](https://github.com/py-pkgs/py-pkgs-cookiecutter). `brewserverblocklist` was created with [`cookiecutter`](https://cookiecutter.readthedocs.io/en/latest/) and the `py-pkgs-cookiecutter` [template](https://github.com/py-pkgs/py-pkgs-cookiecutter).