Commit Messages¶
adacovex uses Conventional Commits. The format is
<type>(<scope>): <description>. These conventions live on this page so
human contributors and LLM coding agents read and apply
the same rules. Every commit in the repository follows them.
Types¶
Type |
Use for |
|---|---|
|
A new feature for a user. |
|
A defect repair. |
|
A documentation change only. |
|
A code change with no new behaviour. |
|
A test change only. |
|
A change that improves a measured result. |
|
The task runner, a manifest, or a build setting. |
|
The workflows and the composite action. |
|
A task with no product change, such as a new scope row. |
The scope table¶
The scope names the component the change serves. It comes from this table; a folder name is never a scope on its own.
Scope |
Covers |
|---|---|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
The |
|
The bundled tldr page ( |
|
|
The rules for a scope¶
Keep the subject up to 72 characters. Start with a verb, end the subject without a full stop, and use British English.
Name the one component the change serves. Omit the scope when the change touches the whole repository, and never repeat the type as the scope.
Never invent a scope. Add its row to the table above first, in a
chore:commit of its own.Split a change that touches two components into two commits. Explain why the change was needed, never what the diff shows.
Link the issue at the end of the body with
Closes #123.Regenerated artifacts (
sbom.json,test_result.md,docs/test_result.md,docs/api-docs/, the version spec, and the bundled template specs) ride with the commit that triggers them.
Examples¶
fix(parsers): keep the cached source walk out of dot links
fix(tests): fail the process when the native suite is red
docs: rewrite the plan for v1.62.0 and ASCII-clean the perf notes
Suggesting a message¶
After you finish a change, suggest the commit message and do not run
the commit yourself unless the user asks for it. Give the message in a
fenced block, state why the scope fits, name the version in plan.md
(the work plan at the repository root) the change belongs to, and say
whether the change needs a MAJOR version.