git-conventional-commit-messages
Commit messages in the Conventional Commits format: a type, an optional scope and a description.
- Kind
- Rules
- Works with
- Cursor
- Source
- Awesome Cursor Rules @ b044f956f021
- Path
- rules/git-conventional-commit-messages.mdc
- License
- CC0-1.0
- Jobs
- Git workflow
InstallCopy it from the source repository, or sign in and let the assistant adapt it for your project.
Use the Conventional Commit Messages specification to generate commit messages The commit message should be structured as follows: ``` <type>[optional scope]: <description> [optional body] [optional footer(s)] ``` -------------------------------- The commit contains the following structural elements, to communicate intent to the consumers of your library: - fix: a commit of the type fix patches a bug in your codebase (this correlates with PATCH in Semantic Versioning). - feat: a commit of the type feat introduces a new feature to the codebase (this correlates with MINOR in Semantic Versioning). - BREAKING CHANGE: a commit that has a footer BREAKING CHANGE:, or appends a ! after the type/scope, introduces a breaking API change (correlating with MAJOR in Semantic Versioning). A BREAKING CHANGE can be part of commits of any type. - types other than fix: and feat: are allowed, for example @commitlint/config-conventional (based on the Angular convention) recommends build:, chore:, ci:, docs:, style:, refactor:, perf:, test:, and others. - footers other than BREAKING CHANGE: <description> may be provided and follow a convention similar to git trailer format. …