Skip to content

Commit f16be8f

Browse files
Monkeypacsebastien-boulle
authored andcommitted
docs(template): add usage of commit template
1 parent 0f5d26c commit f16be8f

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

+10
Original file line numberDiff line numberDiff line change
@@ -207,6 +207,16 @@ in `.git/hooks` directory of your repository.
207207
- if `COMMIT_VALIDATOR_NO_JIRA` environment variable is not empty, no validation is done on JIRA refs.
208208
- if `COMMIT_VALIDATOR_ALLOW_TEMP` environment variable is not empty, no validation is done on `fixup!` and `squash!` commits.
209209

210+
### Commit template
211+
212+
You might want to use the predefined commit template in order to keep the main information under hand.
213+
214+
For that, you have to add the following lines in your repository's gitconfig (located at `<project_root>/.gitconfig`).
215+
```conf
216+
[commit]
217+
template = /path/to/git-commit-template
218+
```
219+
210220
## Getting Started with github action
211221

212222
To enable the action simply create the .github/workflows/commit-message-validator.yml file with the following content:

0 commit comments

Comments
 (0)