From 19b8d68cf8ea0dca722b1630edd9e6834a126fc0 Mon Sep 17 00:00:00 2001 From: Donatas Abraitis Date: Tue, 31 Jan 2023 12:36:38 +0200 Subject: [PATCH] doc: Add a documentation about commit conventions Signed-off-by: Donatas Abraitis --- doc/developer/workflow.rst | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/doc/developer/workflow.rst b/doc/developer/workflow.rst index 88ee358384..605525818b 100644 --- a/doc/developer/workflow.rst +++ b/doc/developer/workflow.rst @@ -354,6 +354,19 @@ Before merging make sure a PR has squashed the following kinds of commits: This helps to automatically generate human-readable changelog messages. +Commit Guidelines +----------------- + +There is a built-in commit linter. Basic rules: + +- Commit messages must be prefixed with the name of the changed subsystem, followed + by a colon and a space and start with an imperative verb. + + `Check `_ all + the supported subsystems. + +- Commit messages must start with a capital letter +- Commit messages must not end with a period ``.`` .. _license-for-contributions: -- 2.39.5