From d5229b1750fcc88ad38c55d74e8004ecc5d66f48 Mon Sep 17 00:00:00 2001 From: Alexander Engelsberger Date: Wed, 16 Jun 2021 14:25:04 +0200 Subject: [PATCH] docs(githooks): Add usage guide for pre-commit to readme --- README.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.md b/README.md index 4e85b7b..fc80f3f 100644 --- a/README.md +++ b/README.md @@ -48,6 +48,17 @@ pip install -e .[all] The documentation is available at . Should that link not work try . +## 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: