Skip to main content

Fix your damn commit message grammar!

Project description

Fix your damn commit message grammar!

https://badge.fury.io/py/grammaticommit.svg

TL;DR: Commit in imperative mood

https://i.imgur.com/gc4yEpw.gif

What does this do?

This is a commit-msg git hook (i.e. it runs just after you made a commit, checking your commit message) that fixes your commit if it doesn’t follow the proper grammatical rules.

This project doesn’t care about the semantics of your commits, you should already know how to properly convey the idea of your changes in the message (separate commits for logically separate changes, meaningful messages, yada yada). grammaticommit only cares about the grammar rules of the message itself.

Also, it only cares about the subject of the commit message, not the body, where the rules are a little bit more relaxed.

How do I use it?

First we need to install the package

pip install grammaticommit

Then, we have the commands to install and uninstall the hook

  • Install the hook for the current repo (this should be used within the repo root): grammaticommit
  • Install the hook globally for all of your git repos: grammaticommit --global
  • Uninstall the hook for the current repo (this should be used within the repo root): grammaticommit --uninstall
  • Uninstall the hook for all of your git repos: grammaticommit --global --uninstall

Remember that if for whatever reason (a false negative in your commit message, for example) you want to skip the check for a single commit, you can always run git commit -m "My message" --no-verify

If you encounter any false negative (a commit message that follows the guidelines, yet it’s being flagged as incorrect, or even being wrongly fixed), please raise up an issue so that I can fix it.

Python Versions

This package correctly works for Python 3.6, but needs a quick fix for Python 3.7 and onwards. Currently, the library that is used to check for the imperative mood is not compatible on their main release with Py>=3.7. To fix this, we must use a dev dependency. So, after doing the pip install grammaticommit one must run pip install git+git://github.com/clips/pattern.git@17f215438166729114762c3d9b3179dacd31490d

Commit grammar

Over the years, everyone and their mother has had an opinion on how to write a proper commit message. There is, however, a canonical way to write commit messages… the Linus way!

Besides using Linus’ ideas, I also incorporated (as long as they don’t contradict Linus) two more sources, Tim Pope, and Chris Beams, whom had written two blog posts that are constantly being shared and used as the bible in terms of how to write a good commit message.

So, the full list of sources for this is, in order of priority:

From all of this sources, the final list of rules that this project follows is…

  • Imperative mood, always
  • 50 characters
  • No trailing period (you are using one precious character!)
  • Optionally, declare the area of the project in which the commit makes changes, prefixing the message with the area and a colon

Note that not everything from the 3 sources was taken into account, only an intersection of them. For example, while Chris and Tim suggest to capitalize the commit, Linus says to commit all in lowercase, so grammaticommit takes no stance on the matter (specially in this particular case because people tend to capitalize everything, in other cases I tend to take Linus word over the rest).

If you have any other grammar rule that a commit message should follow, backed with good sources, make an issue, and I’ll add it.

PS: This doesn’t apply to “Initial Commit” messages.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for grammaticommit, version 0.5
Filename, size File type Python version Upload date Hashes
Filename, size grammaticommit-0.5-py3-none-any.whl (6.7 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size grammaticommit-0.5.tar.gz (5.2 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page