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.3.1
hooks:
- id: commit-msg-hook
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)
- Capitalize the subject line
- Use the imperative mood(e.g. Add instead of Added, Adds or Adding)
- Do not end the lines with any punctuation character
- Use the description to explain what and why vs how
- In case of multiline message do the following:
- Press Shift+Enter to create a new line and to write more characters then vscode lets you
- Separate subject line from message body with a blank line
- Follow the rules above when writing each line of the message
Example
Refactor foo function in x file from y component
* Remove duplications
* Add docstrings
* Update the types of arguments
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.3.1.tar.gz
(5.5 kB
view hashes)
Built Distribution
Close
Hashes for commit_msg_hook-0.3.1-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | a92adbce01662f8ec2163ab41d4bfb54edde928c13da46fb5a7cf86fe7211209 |
|
MD5 | 905e8589147d2f6f9146b7d3635f4643 |
|
BLAKE2b-256 | ddf38e100684a03e1df6cd1121dd6c06cc537e64b8cb975961ff356fe707037c |