Checks if commit message matches the chaos-hub commit rules
Project description
commit-msg-hook
This hook is made as a custom plugin under the pre-commit hook framework and checks if commit message matches the chaos-hub team commit rules.
Installation
pip install commit-msg-hook
Using commit-msg-hook with pre-commit
For more details see: pre-commit
Install pre-commit package manager
pip install pre-commit
Create a file .pre-commit-config.yaml
in the root folder with the following configuration
- repo: https://github.com/dimaka-wix/commit-msg-hook.git
rev: v0.2.7
hooks:
- id: commit-msg-hook
stages: [commit-msg]
Add valid prefixes(optional)
Add additional prefixes as an args:
separated by ,
after the keyword --prefix
and end with the delimiter --
Example
hooks:
- id: commit-msg-hook
args: [--prefix, Check, Modify, --]
stages: [commit-msg]
To enable commit-msg hook with pre-commit run:
pre-commit install --hook-type commit-msg
Update to the latest release (optional)
pre-commit autoupdate --repo https://github.com/dimaka-wix/commit-msg-hook.git
Commit Rules
- Write up to 72 characters(preventing ellipsis in git)
- Capitalise the subject line
- Do not end the subject line with a period
- Use the imperative mood(e.g. Add instead of Added)
- Start message with one of following prefixes
- Add ...
- Change ...
- Create ...
- Disable ...
- Fix ...
- Merge ...
- Move ...
- Refactor ...
- Release ...
- Remove ...
- Rename ...
- Tslint ...
- Update ...
- Use the description to explain what and why vs how
- Press Shift+Enter to create a new line and to write more characters then vscode lets you
- Separate subject from body with a blank line!
Example
Refactor Z function in X file from Y component
<optional part, adding it leave an empty line here>
* Fix ...
* Add ...
* Update ...
Bypass the hook in one of the following ways
SKIP=commit-msg-hook git commit -m "Your message"
git commit -m "Your message" --no-verify
git commit -m "Your message" -n (not recommended)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
commit-msg-hook-0.2.7.tar.gz
(5.7 kB
view hashes)
Built Distribution
Close
Hashes for commit_msg_hook-0.2.7-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 562cbb86c77dd2f9da32aac7162383e9dd2a70826a96151b0d0e12c7dd09bd6a |
|
MD5 | 75e40f1b773f67c1ea125f98475b8a68 |
|
BLAKE2b-256 | c94a41079dcc64b988128b4c50251e2d4552f73ae25675a5a19f3bf7e0c659c4 |