From b94dacea612b822f2ac8f6036bbccf31af3b0345 Mon Sep 17 00:00:00 2001 From: paul1319 Date: Wed, 27 Nov 2019 17:24:25 +0300 Subject: [PATCH 1/3] docs: add commits convention description in CONTRIBUTING.rst --- CONTRIBUTING.rst | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index f606d71ec2e8..963424930521 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -151,6 +151,38 @@ Exceptions to PEP8: "Function-Under-Test"), which is PEP8-incompliant, but more readable. Some also use a local variable, ``MUT`` (short for "Module-Under-Test"). +***************** +Commit Convention +***************** + +We use `Conventional Commits`_ as a convention for writing commit messages. +It provides an easy set of rules for creating an explicit commit history. + +The commit message should be structured as follows:: + + [optional scope]: + + [optional body] + + [optional footer(s)] + +The commit contains the following structural elements: + +- **fix**: a commit of the type `fix` patches a bug in the codebase. +- **feat**: a commit of the type `feat` introduces a new feature to the codebase. +- **BREAKING CHANGE**: a commit that has a footer `BREAKING CHANGE:`, or + appends a `!` after the type/scope, introduces a breaking API change. A + BREAKING CHANGE can be part of commits of any type. +- types other than fix: and feat: are allowed, for example recommends `build:`, + `chore:`, `ci:`, `docs:`, `style:`, `refactor:`, `perf:`, `test:`, `docs:` + and others. +- footers other than BREAKING CHANGE: may be provided and follow + a convention similar to `git trailer format`_. + +.. _Conventional Commits: https://www.conventionalcommits.org/ +.. _git trailer format: https://git-scm.com/docs/git-interpret-trailers + + ******************** Running System Tests ******************** From 90e3de92db5f5045d52fac711c6a3d72d6560fa0 Mon Sep 17 00:00:00 2001 From: paul1319 Date: Wed, 27 Nov 2019 19:51:23 +0300 Subject: [PATCH 2/3] docs: remove extra empty line in CONTRIBUTING.rst --- CONTRIBUTING.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 963424930521..4e55840fe57b 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -182,7 +182,6 @@ The commit contains the following structural elements: .. _Conventional Commits: https://www.conventionalcommits.org/ .. _git trailer format: https://git-scm.com/docs/git-interpret-trailers - ******************** Running System Tests ******************** From ba014d03ba113f10ac79851edf14c432f266eb20 Mon Sep 17 00:00:00 2001 From: kiselev13 Date: Thu, 28 Nov 2019 14:07:03 +0300 Subject: [PATCH 3/3] docs: remove excess lines in CONTRIBUTING.rst --- CONTRIBUTING.rst | 28 +++------------------------- 1 file changed, 3 insertions(+), 25 deletions(-) diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 4e55840fe57b..3567864e4419 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -151,36 +151,14 @@ Exceptions to PEP8: "Function-Under-Test"), which is PEP8-incompliant, but more readable. Some also use a local variable, ``MUT`` (short for "Module-Under-Test"). -***************** -Commit Convention -***************** +************************* +Commit Message Convention +************************* We use `Conventional Commits`_ as a convention for writing commit messages. It provides an easy set of rules for creating an explicit commit history. -The commit message should be structured as follows:: - - [optional scope]: - - [optional body] - - [optional footer(s)] - -The commit contains the following structural elements: - -- **fix**: a commit of the type `fix` patches a bug in the codebase. -- **feat**: a commit of the type `feat` introduces a new feature to the codebase. -- **BREAKING CHANGE**: a commit that has a footer `BREAKING CHANGE:`, or - appends a `!` after the type/scope, introduces a breaking API change. A - BREAKING CHANGE can be part of commits of any type. -- types other than fix: and feat: are allowed, for example recommends `build:`, - `chore:`, `ci:`, `docs:`, `style:`, `refactor:`, `perf:`, `test:`, `docs:` - and others. -- footers other than BREAKING CHANGE: may be provided and follow - a convention similar to `git trailer format`_. - .. _Conventional Commits: https://www.conventionalcommits.org/ -.. _git trailer format: https://git-scm.com/docs/git-interpret-trailers ******************** Running System Tests