brianmituka / git-gud

A simple git commit checker

git-gud

A simple git commit checker. I often use a commit message template I created a while ago, and I wanted to make sure that everything was in the right place after writing a commit, that's why this script exists. Use it if you want to git gud too. To add this custom git command to git, just place the file in a folder that's in your path (a.k.a PATH).

git-gud only works on the last commit of the current branch only, but I'll try to make it work with common options like git gud -n 10 or git gud development. Also a checker for "imperative mood" in the subject seems like a good idea.

Checks

• Commit author name is in a valid format ( Antonio Ossa)
• Commit author name is the same in your config file
• Commit author email is in a valid format ([e-mail])
• Commit author email is the same in your config file
• Commit subject message uses a maximum of 50 characters
• Commit body message is not empty
• Commit body message lines use a maximum of 72 characters
• Commit body message has lines with comments (i.e. not "Signed-off-by: ...")
• Commit body message has a "Signed-off-by: ..." line (Signed-off-by: Antonio Ossa <[e-mail]>)
• Commit signature is "good"

Template

This is the template I use. You can find it as .gitmessage in this repo and install it following these instructions. The script assumes that you're following these conventions, but you can use your own template if you want (or none) and customize the checker too! That's why is OSS ❤️:

# |<----  Using a Maximum Of 50 Characters  ---->|
# If this commit is applied, it will...
# Examples of imperative mood: Refactor X, Update Y, Remove Z
Subject

# |<----   Try To Limit Each Line to a Maximum Of 72 Characters   ---->|
# What/why/how was this change made?

# Any references to relevant tickets, articles, resources, etc?
# Example: GitHub issue #23

# Something more?
# Reported-by: A person or @somebody
Signed-off-by: Antonio Ossa <[e-mail]>

# (:heart: emoji? http://emoji.muan.co/)

To do

• Wiki: How to use template
• Instructions: Use git-gud as custom command
• Instructions: Use git-gud as pre-commit hook
• Script: Allow check multiple commits (git gud -n 10)
• Script: Allow check on another branchs (git gud branch)
• Script: Check imperative mood in subject

License

This software is released under the MIT License