From 7ea0230a86dbee935b256171b07f2f8302917433 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Florian=20M=C3=BCllner?= Date: Tue, 6 Dec 2022 01:29:58 +0100 Subject: [PATCH] doc: Update contribution section We no longer *require* a merge request URL in commit messages, we ban them (since Marge is kind enough to add them for us). While at it, add a small section on prefixes (~~stolen from~~ inspired by mutter). Part-of: --- README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index bf0d9aafa..9de841a65 100644 --- a/README.md +++ b/README.md @@ -17,8 +17,11 @@ Please refer to the [*Schedule* wiki page][schedule] to see the supported versio To contribute, open merge requests at https://gitlab.gnome.org/GNOME/gnome-shell. Commit messages should follow the [GNOME commit message -guidelines](https://wiki.gnome.org/Git/CommitMessages). We require an URL -to either an issue or a merge request in each commit. +guidelines](https://wiki.gnome.org/Git/CommitMessages). If a merge request +fixes an existing issue, it is good practice to append the full issue URL +to each commit message. Try to always prefix commit subjects with a relevant +topic, such as `panel:` or `status/network:`, and it's always better to write +too much in the commit message body than too little. ## Default branch