Commit Message Standards · QUAL-04
Conventional Commits must be used for commit messages · QUAL-04.1 · MUST · DEV/TEST
Commit messages must follow the Conventional Commits specification.
It is strongly recommended that projects at least use types from the specification to communicate the main purpose of the commit, e.g.:
feat:for new featuresfix:for bug fixesdocs:for documentation changesrefactor:for refactoring- etc. (any type from the specification can be used)
Projects can optionally go beyond just using the type and follow the full specification, which includes additional features such as:
- Including a scope after the type, e.g. the scope
apiafter a feature would befeat(api): - Communicating breaking changes by appending a
!after the type/scope, e.g.feat!: - Including a footer
Commit messages must including work item number · QUAL-04.2 · MUST · DEV/TEST
The work item number (e.g. PBI or Bug) must be added to the end of the commit message. For example:
fix: added phone number validation #xxxx, where #xxxx is the card related to the commit