Git commit message checker

A configurable commit message checker compatible with pre-commit.

Clear and informative commit messages promote good collaboration and more effective code reviews. The checker enforces the following guidelines:

• The header of the commit message must have the following format:

  new[optimizer]: add new option to adjust learning rate
  
  More details about the commit here.

• The prefix should be one of those:

  • new: when a new feature is added.
  • fix: when a bug is fixed.
  • refactor: when reorganizing or restructuring existing code.
  • docs: when making changes related to documentation or comments.
  • minor: when modifying trivial aspects of the codebase (e.g., formatting).
  • build: when modifying build components (build tool, ci pipeline, dependencies, project version, ...).
  • misc: when modifying miscellaneous aspects of the code base.

• The component (in brackets) tells the reader which area of the code is impacted by the change.

• The first line must not exceed 50 characters (configurable via --max-summary-length).

• The summary should not end with a dot.

• Any line must not exceed 72 characters (configurable via --max-line-length).

Usage

Add the following to your .pre-commit-config.yaml:

- repo: https://github.com/gmermoud/git-msg-check.git
  rev: "insert the version you want to use"
  hooks:
    - id: git-msg-check
      name: Validate commit message
      stages: [commit-msg]
      language_version: python3
      args: ["--max-summary-length=55"]

Then, you may install the hook using:

pre-commit install -t commit-msg

Contribute, bug reports or feature requests

I will gladly review and accept your changes if you submit a PR. Feel free to open an issue for any bug or feature request.