From 292d58bb8fd763075303233cd97055f2858de896 Mon Sep 17 00:00:00 2001 From: Oliver Klee Date: Tue, 31 Dec 2024 10:01:00 +0100 Subject: [PATCH] [TASK] Add a section on git commits to `CONTRIBUTING.md` Copied from our sister project without any changes. Part of #489 --- CONTRIBUTING.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 77013eea..6290793b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -108,3 +108,14 @@ You can autoformat your code using the following command: ```bash composer fix ``` + +## Git commits + +Commit message should have a <= 50-character summary, optionally followed by a +blank line and a more in depth description of 79 characters per line. + +Please use grammatically correct, complete sentences in the commit messages. + +Also, please prefix the subject line of the commit message with either +`[FEATURE]`, `[TASK]`, `[BUGFIX]` OR `[CLEANUP]`. This makes it faster to see +what a commit is about.