From f1ad4d19128dad5e3fb12f1c11f2bb612bf163d4 Mon Sep 17 00:00:00 2001 From: Mario Erazo Date: Mon, 14 Jun 2021 12:02:25 +0200 Subject: [PATCH] Add convential commits item --- radar/2021-01-01/conventionalcommits.md | 9 +++++++++ 1 file changed, 9 insertions(+) create mode 100644 radar/2021-01-01/conventionalcommits.md diff --git a/radar/2021-01-01/conventionalcommits.md b/radar/2021-01-01/conventionalcommits.md new file mode 100644 index 0000000..9109599 --- /dev/null +++ b/radar/2021-01-01/conventionalcommits.md @@ -0,0 +1,9 @@ +--- +title: "Conventional Commits" +ring: trial +quadrant: methods-and-patterns +featured: false +--- +The Conventional Commits specification is a lightweight convention on top of commit messages. It provides an small set of rules for writing commit messages and therefore creating an explicit commit history. The convention dovetails with [SemVer](https://semver.org/), by describing the features, fixes, and breaking changes made in commit messages. The specification contains only 16 items that are easy to follow. The predefined structure allows everyone in the team to get a better overview of what the commit messages relates to and what part of the code a change has to do with. Some of the benefits of using this specifications include: the ability to automatically generate changelogs, the ability to determine a semantic version bump (based on the types of commits landed) and being able to communicate the nature of changes to teammates and stakeholders. + +We use conventional commits in the team with the help of a git template. The template contains a guide of elements that are required in the specification plus some information about project specific items that should also be part of a commit, such as a ticket number.