From 043b118d8b9e61b12209c9e434c9c3c5d902da76 Mon Sep 17 00:00:00 2001 From: Florence Blanc-Renaud Date: Tue, 8 Feb 2022 15:16:51 +0100 Subject: [PATCH] Commit template: use either Fixes or Related Update the commit template to be consistent with the commit message requirements described at https://www.freeipa.org/page/Contribute/Code#Commit_message_requirements Signed-off-by: Florence Blanc-Renaud Reviewed-By: Mohammad Rizwan --- .git-commit-template | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/.git-commit-template b/.git-commit-template index 6076f1aaf..04c3ed167 100644 --- a/.git-commit-template +++ b/.git-commit-template @@ -1,5 +1,14 @@ component: Subject +# component: Subject is a single-line summary Explanation +# Explanation must describe the fix or feature + the method +# chosen to implement it, and can span across multiple lines. + +Fixes: https://pagure.io/freeipa/issue/XXXX +or +Related: https://pagure.io/freeipa/issue/XXXX +# Fixes: means that the commit fixes the referenced issue(s). +# Related: means that the commit is related to the issue(s) +# in some way, but does not resolve it/them. -https://pagure.io/freeipa/issue/XXXX