From ebb016fa81680674fce5f9618fd464a02a63531f Mon Sep 17 00:00:00 2001 From: Stefan Profanter Date: Fri, 2 Aug 2019 10:57:49 +0200 Subject: [PATCH] docs: Update contributing guidelines for conventional commits --- CONTRIBUTING.md | 95 +++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 92 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 93a2af1b9..7da2e39f2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -43,7 +43,97 @@ The following are the minimal requirements that every PR needs to meet. link automatically appears on the page of the first PR. In addition, the CLA text can be accessed [here](https://cla-assistant.io/open62541/open62541). -### Commit and PR Hygiene +## Commit and PR Hygiene + +We have very precise rules over how our git commit messages can be formatted. This leads to **more +readable messages** that are easy to follow when looking through the **project history**. But also, +we use the git commit messages to **generate the change log**. + +This convention is identical to the [Conventional Commits](https://www.conventionalcommits.org) specification or the one used by Angular. + +### Commit Message Format +Each commit message consists of a **header**, a **body** and a **footer**. The header has a special +format that includes a **type**, a **scope** and a **subject**: + +```text +(): + + + +