|
| 1 | +conventional-commit "types" |
| 2 | + |
| 3 | +feat | ✨ Features | minor | |
| 4 | +| fix | 🐛 Bug Fixes | patch | |
| 5 | +| hotfix | 🚑 Hotfixes | patch | |
| 6 | +| security | 🔒 Security | patch | |
| 7 | +| deps | 📦 Dependencies | patch | |
| 8 | +| wip | (omitted) | - | |
| 9 | +| release |
| 10 | + |
| 11 | +- wip|🚧|👷(<scope>): Work in progress |
| 12 | +- chore|🧹(<scope>): Maintenance tasks, dependencies |
| 13 | + - cleanup/trivial changes, syntax fixes, etc. |
| 14 | + - "Maintenance work and dependency updates" |
| 15 | +- docs|📖(<scope>): Some sort of documentation change/addition |
| 16 | + - "Updating documentation and guides" |
| 17 | + - "Updating doc-comments (pydocs)" |
| 18 | +- feat|✨(<scope>)[!]: a new feature |
| 19 | + - "Adding new functionality to the application" |
| 20 | +- security|🔒(<scope>)[!]: a Security related change |
| 21 | +- hotfix|🚑(<scope>)[!]: a Hotfix |
| 22 | +- fix|🐛(<scope>)[!]: a bug fix |
| 23 | + - "Resolving issues and errors" |
| 24 | +- perf|🏎️(<scope>)[!]: Performance improvements |
| 25 | + - "Optimizing application performance" |
| 26 | +- refactor|🐙(<scope>)[!]: Code cleanup without changing functionality |
| 27 | + - "Improving code structure while maintaining the same behavior" |
| 28 | + - "no functional changes, but improves code structure or readability or organization" |
| 29 | +- revert|⏪(<scope>): revert a previous commit |
| 30 | +- style|🕺(<scope>): code style changes (Formatting, whitespace, semicolons) |
| 31 | + - "Code formatting changes without logic modifications" |
| 32 | +- test|🧪|⚗️(<scope>)[!]: Adding or updating tests |
| 33 | + - "Adding test coverage and test improvements" |
| 34 | +- deps|📦(<scope>): Dependency updates only |
| 35 | + - "Updating dependencies and packages" |
| 36 | +- ai|🤖(<scope>): AI tooling changes |
| 37 | + - "Changing agent rules/context" |
| 38 | +- ci|🔄(<scope>): CI/CD pipeline changes (including pre-commit) |
| 39 | + - "Continuous integration and deployment updates" |
| 40 | + - "automated dependency updates" |
| 41 | +- build|🛠️|⚙️|🧰(<scope>)[!]: Build system changes |
| 42 | + - "Build configuration and tooling updates" |
| 43 | + |
| 44 | +> '[!]|⛓️💥' signifies a breaking change with a 'type'; if a type does not have '[!]' after it in the above list it CANNOT have a breaking change. |
| 45 | +
|
| 46 | +conventional-commit "footers |
| 47 | + |
| 48 | +- BREAKING CHANGE: a breaking change |
| 49 | +- 'signed-off-by: John Doe <john.doe@example.com>': include a signed-off-by footer line for all committers |
| 50 | + - This should include at least "git.username <git.email>" |
| 51 | + - If an AI Tool is used, it should be signed as "Model or AI Tool Used <agent.id@arusty.dev>" |
| 52 | + |
| 53 | +conventional-commit "scopes" |
| 54 | + |
| 55 | +- Core: core, api, cli, config |
| 56 | +- MCP: mcp, transport, tools, resources, prompts |
| 57 | +- Infra: ci, docker, deps, docs |
0 commit comments