diff options
| -rw-r--r-- | docs/hacking/index.rst | 7 | ||||
| -rw-r--r-- | docs/hooks/leap-commit-template.README | 5 |
2 files changed, 8 insertions, 4 deletions
diff --git a/docs/hacking/index.rst b/docs/hacking/index.rst index 2a48a7b..4826f48 100644 --- a/docs/hacking/index.rst +++ b/docs/hacking/index.rst @@ -44,7 +44,12 @@ Merge requests to https://0xacab/leap/bitmask-dev Coding conventions --------------------------------- * pep8 -* pre-commit hook (more utils in docs/hooks folder) +* Git messages should be informative. +* There is a pre-commit hook ready to be used in the ``docs/hooks`` folder, + alongside some other hooks to do autopep8 on each commit. + +.. include:: ../hooks/leap-commit-template.README + :literal: Pinning ---------------------------------- diff --git a/docs/hooks/leap-commit-template.README b/docs/hooks/leap-commit-template.README index ce8809e..e54c037 100644 --- a/docs/hooks/leap-commit-template.README +++ b/docs/hooks/leap-commit-template.README @@ -2,10 +2,9 @@ HOW TO USE THIS TEMPLATE: ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Run `git config commit.template docs/leap-commit-template` or +Run `git config commit.template docs/hooks/leap-commit-template` or edit the .git/config for this project and add -`template = docs/leap-commit-template` -under the [commit] block +`template = docs/hooks/leap-commit-template` under the [commit] block ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ COMMIT TEMPLATE FORMAT EXPLAINED |