Checks if commit message matches the chaos-hub commit rules
Project description
commit-msg-hook
This hook is made as custom plugins 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
See pre-commit for instructions
Add this to your .pre-commit-config.yaml
- repo: hhttps://github.com/dimaka-wix/commit-msg-hook.git
rev: v0.2.5
hooks:
- id: commit-msg-hookcs
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-hookcs
args: [--prefix, Check, Modify, --]
stages: [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.5.tar.gz
(5.4 kB
view hashes)
Built Distribution
Close
Hashes for commit_msg_hook-0.2.5-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 256b1fc08306f44d984dc9cd82adde1c845766d1a9e1f5bc8b6f584febd591e2 |
|
MD5 | 9e744053fdbc7eb0d3a7bd53c5b6fc8d |
|
BLAKE2b-256 | ba89ac828d9ad60f54871fde0fdd04ba5f729c80fee64e3e6ec3c95be35c5b7a |