julius/prototorch
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs(githooks): Add usage guide for pre-commit to readme

Browse Source
This commit is contained in:
Alexander Engelsberger 2021-06-16 14:25:04 +02:00 committed by Alexander Engelsberger
parent fc4b143fbb
commit d5229b1750
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -48,6 +48,17 @@ pip install -e .[all]
The documentation is available at <https://www.prototorch.ml/en/latest/>. Should
that link not work try <https://prototorch.readthedocs.io/en/latest/>.
## Contribution
This repository contains definition for [git hooks](https://githooks.com).
[Pre-commit](https://pre-commit.com) gets installed as development dependency with prototorch.
Please install the hooks them by running
```bash
pre-commit install
pre-commit install --hook-type commit-msg
```
before creating the first commit.
## Bibtex
If you would like to cite the package, please use this: