Tidy git commit messages, linting, and logging
Project description
git-tidy
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 usesgit 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.
Documentation
View the git-tidy docs here for a complete tutorial on using git-tidy
.
Installation
One can install git-tidy
system-wide with pipx:
pipx install git-tidy
or pip:
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
.
Compatibility
git-tidy
is compatible with Python 3.8 - 3.12.
Contributing Guide
For information on setting up git-tidy for development and contributing changes, view CONTRIBUTING.rst <CONTRIBUTING.rst>
_.
Creators
- @wesleykendall (Wes Kendall)
- @tomage (Tómas Árni Jónasson)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
git_tidy-1.2.2.tar.gz
(14.7 kB
view hashes)
Built Distribution
git_tidy-1.2.2-py3-none-any.whl
(15.8 kB
view hashes)