Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tommarshall/git-good-commit
Git hook to help you write good commit messages, with no external dependencies.
https://github.com/tommarshall/git-good-commit
best-practices commit-conventions commit-message git git-hooks hooks
Last synced: 5 days ago
JSON representation
Git hook to help you write good commit messages, with no external dependencies.
- Host: GitHub
- URL: https://github.com/tommarshall/git-good-commit
- Owner: tommarshall
- License: mit
- Created: 2016-08-31T09:58:26.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2023-05-15T12:24:31.000Z (over 1 year ago)
- Last Synced: 2024-08-02T18:43:28.361Z (3 months ago)
- Topics: best-practices, commit-conventions, commit-message, git, git-hooks, hooks
- Language: Shell
- Homepage:
- Size: 606 KB
- Stars: 193
- Watchers: 4
- Forks: 33
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# git-good-commit
[](https://travis-ci.org/tommarshall/git-good-commit)
Git hook to help you write good commit messages.
Validates commit messages conform to six of [the seven rules of a great git commit message](http://chris.beams.io/posts/git-commit/), plus a couple of extras:
1. [Separate subject from body with a blank line](http://chris.beams.io/posts/git-commit/#separate)
2. [Limit the subject line to 50 characters](http://chris.beams.io/posts/git-commit/#limit-50)
3. [Capitalize the subject line](http://chris.beams.io/posts/git-commit/#capitalize)
4. [Do not end the subject line with a period](http://chris.beams.io/posts/git-commit/#end)
5. [Use the imperative mood in the subject line](http://chris.beams.io/posts/git-commit/#imperative)
6. [Wrap the body at 72 characters](http://chris.beams.io/posts/git-commit/#wrap-72)
7. ~~[Use the body to explain what and why vs. how](http://chris.beams.io/posts/git-commit/#why-not-how)~~ _- you're on your own with this one_
8. Do no write single worded commits
9. Do not start the subject line with whitespace
Offers an interactive prompt if any of the rules are detected to be broken.
## Installation
### Single repository
At the root of the repository, run:
```sh
curl -L https://cdn.rawgit.com/tommarshall/git-good-commit/v0.6.1/hook.sh > .git/hooks/commit-msg && chmod +x .git/hooks/commit-msg
```
### Globally
To use the hook globally, you can use `git-init`'s template directory:
```sh
mkdir -p ~/.git-template/hooks
git config --global init.templatedir '~/.git-template'
curl -L https://cdn.rawgit.com/tommarshall/git-good-commit/v0.6.1/hook.sh > ~/.git-template/hooks/commit-msg && chmod +x ~/.git-template/hooks/commit-msg
```
The hook will now be present after any `git init` or `git clone`. You can [safely re-run `git init`](http://stackoverflow.com/a/5149861/885540) on any existing repositories to add the hook there.
---
_If you're security conscious, you may be reasonably suspicious of [curling executable files](https://www.seancassidy.me/dont-pipe-to-your-shell.html). In this case you're on HTTPS throughout, and not piping directly to execution, so you can check contents and the hash against MD5 `12fd3b8829eead2eff9a72598cbc9f4b` for v0.6.1._
## Usage
```sh
echo "apple" > ./bar.txt
git add fruits.txt
# should warn you that the subject line is not capitalised, and offer an interactive prompt.
git commit -m 'add fruits.txt'
```
### Options
```
e - edit commit message
y - proceed with commit
n - abort commit
? - print help
```
## Configuration
The default colour setting is `auto`, but the hook will use `git`'s `color.ui` config setting if defined. You override the colour setting for the hook with:
```
git config --global hooks.goodcommit.color "never"
```
Supported values are `always`, `auto`, `never` and `false`.
## Dependencies
None, other than Bash.
## Credits
* http://chris.beams.io/posts/git-commit
* http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
* https://www.git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project#Commit-Guidelines
* Tim Perry's excellent [git-confirm](https://github.com/pimterry/git-confirm) hook, which provided the inspiration and much of the scaffolding for this hook.