Skip to Content
Engineering PracticesCommit Messages

Commit Messages

Conventional commits, with the reason in the body.

<type>(<scope>): <subject> <body: what changed and why> Refs #<issue>
TypeUse for
featA new capability
fixA bug fix
refA change in structure with no change in behaviour
testTests only
docsDocumentation only
ciWorkflows and build

The subject says what the commit does, in the imperative. The body says why, and what was and was not verified. Reference the issue.