When researching the “Thea’s Pantry” group on Gitlab I came across Conventional Commits. Conventional Commits is a system of writing commits that can be used for parsing by conventional keywords and formatting. This can be used to automatically generate CHANGELOGs and automate semantic versioning.
Conventional Commits is formatted as <type>[optional scope]: <description>
. This creates a consistent format to write/read comments and can help you quickly find commits when searching for a specific commit. You also have the option to include a body and footers. These bodies and footers also have their own specific formatting to facilitate automated parsing. If convention is not followed commits can be squashed and reformatted upon merge by a project administrator.
From the blog CS@Worcester – Ryan Blog by rtrembley and used with permission of the author. All other rights reserved by the author.