Skip to content

Commit ec24360

Browse files
committed
;dev: bin: commitlint: advertise how to use it locally
1 parent 103813f commit ec24360

File tree

1 file changed

+7
-1
lines changed

1 file changed

+7
-1
lines changed

bin/commitlint

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,13 @@ Mention any related issues, usually parenthesised at end of summary: (#1234)
107107
108108
These conventions are evolving. In practice, any type or topic will do.
109109
Use your best judgement and we'll polish during code review.
110-
More detail: https://hledger.org/CONTRIBUTING.html#commit-messages
110+
More context: https://hledger.org/CONTRIBUTING.html#commit-messages
111+
112+
You can set up this script to check your commit messages locally:
113+
1. before committing:
114+
a. safer but must redo: cp bin/commitlint .git/hooks/commit-msg
115+
b. more convenient: ln -s ../../bin/commitlint .git/hooks/commit-msg
116+
2. before pushing: bin/commitlint && git push
111117
---------------------------------------------------------------------------
112118
EOF
113119

0 commit comments

Comments
 (0)