Nitpicking commit history since
beabf39
Enforce commit standards, whether for:
- Readability, especially in logs
- Consistent styling
- Compatibility with programmatic processing
Download a pre-built binary (installable via gh-install.
Or use rust to install:
cargo install committed
To use committed
with pre-commit
, point its
config at this repository:
repos:
- repo: https://github.com/crate-ci/committed
rev: v1.1.7
hooks:
- id: committed
The committed
id installs a prebuilt executable from GitHub releases. If
one does not exist for the target platform, or if one built from
sources is preferred, use committed-src
as the hook id instead.
Be sure to change rev
to use the desired committed
git tag or
revision.
By default, the pre-commit install
only installs hooks of the pre-commit
type,
so you may need to list the commit-msg
hook during installation:
pre-commit install -t pre-commit -t commit-msg
or update your .pre-commit-config.yaml
like so:
default_install_hook_types: [pre-commit, commit-msg]
The hook, by default, will verify your commit message.
Verify your latest commit
committed HEAD
Verify your branch
committed master..HEAD --no-merge-commit
Have your CI verify your PR (assuming it does a no-ff merge into your master
)
committed HEAD~..HEAD^2 --no-merge-commit
See imperative
for a GitHub Actions
example
or look at committed
s own GitHub Actions pipeline,
.travis.yml
, or appveyor.yml
.
Licensed under either of
- Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
at your option.