Skip to main content

Tidy git commit messages, linting, and logging

Project description

git-tidy is a set of git extensions for:

  1. 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.
  2. Linting a commit log. git tidy-lint verifies that commits match the schema. If a user uses git tidy-commit, commits will always validate.
  3. 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.
https://raw.githubusercontent.com/jyveapp/git-tidy/master/docs/_static/tidy-commit.gif

Documentation

View the git-tidy docs here for a complete tutorial on using git-tidy.

Installation

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

Note

git-tidy depends on git at a version of 2.22 or higher. OSX users can upgrade to the latest git version with homebrew using brew install git.

Contributing Guide

For information on setting up git-tidy for development and contributing changes, view CONTRIBUTING.rst.

Primary Authors

  • @wesleykendall (Wes Kendall)
  • @tomage (Tómas Árni Jónasson)

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 git-tidy, version 1.0.4
Filename, size File type Python version Upload date Hashes
Filename, size git_tidy-1.0.4-py3-none-any.whl (25.7 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size git-tidy-1.0.4.tar.gz (23.1 kB) File type Source Python version None Upload date Hashes View

Supported by

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