CommitMe

CommitMe provides a Pre-commit hook, GitHub Action, and Command Line Interface for validating commit messages against the Conventional Commits specification;

• Rich error messages to help identify non-compliances:

• Adds labels (feature, fix, or breaking) to your Pull Request
• Limiting Conventional Commits scope and types.

Please refer to the document related to your environment for more details on the usage instructions:

• GitHub Actions
• Command Line Interface
• Pre-commit Hook

Configuration file

You can create a global configuration file:

{
  "types": [ "build", "chore", "ci", "docs", "style", "refactor", "perf", "test" ],
  "scopes": [ "server", "client" ]
}

Configuration Item	Description
types	Conventional Commit types to allow. By default it always supports feat and fix.
scopes	Conventional Commit scopes to allow. No restrictions will be applied when not specified.

💡 By default, CommitMe will attempt to load .commit-me.json in the root of your repository

Contributing

If you have suggestions for how commit-me could be improved, or want to report a bug, open an issue! We'd love all and any contributions.

For more, check out the Contributing Guide.

License

• MIT © 2023 Kevin de Jong <monkaii@hotmail.com>
• CC-BY-3.0 © 2023 Free Software Foundation Europe e.V.