From 25ea25368a7ccf9b65c10f87c744ea4526c90ed0 Mon Sep 17 00:00:00 2001 From: Niels de Vos Date: Mon, 11 May 2020 14:51:27 +0200 Subject: [PATCH] doc: add list of valid components to the development guide The commitlint CI job uses the configuration from .commitlintrc.yaml which contains the different components that Ceph-CSI uses. A short description of each component has been added, so that contributors understand what component to mention in the prefix of the subject in commit messages. Signed-off-by: Niels de Vos --- docs/development-guide.md | 24 +++++++++++++++++++++--- 1 file changed, 21 insertions(+), 3 deletions(-) diff --git a/docs/development-guide.md b/docs/development-guide.md index 866a95cc3..a9fc92ada 100644 --- a/docs/development-guide.md +++ b/docs/development-guide.md @@ -122,13 +122,31 @@ Signed-off-by: Random J Developer The format can be described more formally as follows: ```text -: +: - + -