Appendix B - Commits Conventions
Edited 2 years 7 months ago
The Conventional Commits specification is a simple convention on top of commit messages. It provides an easy set of rules for creating an explicit commit history. Here we made some subtle modifications.
<type><(optional scope)>: <description> <[JIRA ID]>.
<type>
The type is intended to describe the category of your change. The most common types are: build, chore, ci, docs, feat, fix, perf, refactor, revert, style and test.
(optional scope)
The second, optional part is the so called scope. The scope Describes the module affected by your change.
<description>
The description is where describe the alterations made by your commit.
[JIRA ID]
To identify who made the changes we use the Jira ID.
Some examples:
feat: add that dreamed resource [BUDG-111].fix(accordion): change padding to the right variable [BUDG-222].docs: improve README System Requirements list [BUDG-333].
