https://github.com/crate-ci/committed
Nitpicking commit history since beabf39
https://github.com/crate-ci/committed
git
Last synced: 6 months ago
JSON representation
Nitpicking commit history since beabf39
- Host: GitHub
- URL: https://github.com/crate-ci/committed
- Owner: crate-ci
- License: apache-2.0
- Created: 2019-07-26T18:35:21.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2025-05-15T23:47:05.000Z (6 months ago)
- Last Synced: 2025-05-16T00:28:19.818Z (6 months ago)
- Topics: git
- Language: Rust
- Homepage:
- Size: 843 KB
- Stars: 116
- Watchers: 4
- Forks: 7
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# committed
> **Nitpicking commit history since `beabf39`**
[](https://codecov.io/gh/crate-ci/committed)
[][Documentation]
[][Crates.io]
Enforce commit standards, whether for:
- Readability, especially in logs
- Consistent styling
- Compatibility with programmatic processing
## Install
[Download](https://github.com/crate-ci/committed/releases) a pre-built binary
(installable via [gh-install](https://github.com/crate-ci/gh-install).
Or use rust to install:
```bash
cargo install committed
```
### pre-commit
To use `committed` with [`pre-commit`](https://pre-commit.com), point its
config at this repository:
```yaml
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.
The hook, by default, will verify your commit message.
## Basic Usage
Verify your latest commit
```bash
committed HEAD
```
Verify your branch
```bash
committed master..HEAD --no-merge-commit
```
Have your CI verify your PR (assuming it does a no-ff merge into your `master`)
```bash
committed HEAD~..HEAD^2 --no-merge-commit
```
See [`imperative` for a GitHub Actions
example](https://github.com/crate-ci/imperative/blob/master/.github/workflows/committed.yml)
or look at `committed`s own [GitHub Actions pipeline](.github/workflows/committed.yml),
[`.travis.yml`](.travis.yml), or [`appveyor.yml`](appveyor.yml).
## [Reference](docs/reference.md)
## [Contribute](CONTRIBUTING.md)
## License
Licensed under either of
* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or )
* MIT license ([LICENSE-MIT](LICENSE-MIT) or )
at your option.
[Crates.io]: https://crates.io/crates/committed
[Documentation]: https://docs.rs/committed