summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorFlorian Müllner <fmuellner@gnome.org>2022-12-06 01:29:58 +0100
committerFlorian Müllner <fmuellner@gnome.org>2022-12-06 01:49:24 +0100
commit7ea0230a86dbee935b256171b07f2f8302917433 (patch)
tree8b3d0d2f84feff54f64b438d7d074b1b98514952 /README.md
parent2e8e1fe8fcd5af37dff7efccc17269366a2001b2 (diff)
downloadgnome-shell-7ea0230a86dbee935b256171b07f2f8302917433.tar.gz
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: <https://gitlab.gnome.org/GNOME/gnome-shell/-/merge_requests/2572>
Diffstat (limited to 'README.md')
-rw-r--r--README.md7
1 files 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