committed

Nitpicking commit history since beabf39

Enforce commit standards, whether for:

• Readability, especially in logs
• Consistent styling
• Compatibility with programmatic processing

Install

Download a pre-built binary (installable via gh-install.

Or use rust to install:

cargo install committed

pre-commit

To use committed with pre-commit, point its config at this repository:

repos:
  - repo: https://github.com/crate-ci/committed
    rev: v1.1.1
    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.

The hook, by default, will verify your commit message.

Basic Usage

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 committeds own GitHub Actions pipeline, .travis.yml, or appveyor.yml.

Reference

Contribute

License

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.