@wesleykendall (Wes Kendall)
@tomage (Tómas Árni Jónasson)
Tidy git commit messages, linting, and logging
git-tidy is a set of git extensions for:
Keeping your git logs tidy with ease. git tidy-commit guides users through a structured commit with a configurable schema. git tidy-squash squashes messy commits into one tidy commit.
Linting a commit log. git tidy-lint verifies that commits match the schema. If a user uses git tidy-commit, commits will always validate.
Rendering a commit log. git tidy-log can render commits from any range and can render structured commits from a configurable Jinja template. Want to automatically generate release notes? git tidy-log can be configured to group and render commits based on the schema.
View the git-tidy docs here for a complete tutorial on using git-tidy.
git-tidy can be installed a number of ways. The preferred way on OSX is with homebrew
brew tap jyveapp/homebrew-tap brew install git-tidy
If not on OSX, one can install git-tidy system-wide with pipx:
pipx install git-tidy
git-tidy can also be installed with pip. Be sure to install it system-wide so that git-tidy’s execution is not tied to a virtual environment:
pip3 install git-tidy
For information on setting up git-tidy for development and contributing changes, view CONTRIBUTING.rst.
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.