about summary refs log tree commit diff
path: root/CONTRIBUTING.md
diff options
context:
space:
mode:
authorMartin Weinelt <hexa@darmstadt.ccc.de>2022-04-05 04:22:07 +0200
committerMartin Weinelt <hexa@darmstadt.ccc.de>2022-04-05 12:50:46 +0200
commitcd00cafaaddb06e4b7075e0ca1562dd8610a9e7a (patch)
treecd6749617d2dc350a8d26594af32a60b3a63c3b3 /CONTRIBUTING.md
parentfb968e0869a8914eff47cf0bc6301e016a12e60a (diff)
CONTRIBUTING.md: encourage linking release notes on updates
Makes it easier for reviewers to look through the changes and is a sane
default to reference if one exists.
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r--CONTRIBUTING.md3
1 files changed, 2 insertions, 1 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 0f8b5faef12dd..b90598e679119 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -20,7 +20,7 @@ Below is a short excerpt of some points in there:
   ```
   (pkg-name | nixos/<module>): (from -> to | init at version | refactor | etc)
 
-  (Motivation for change. Additional information.)
+  (Motivation for change. Link to release notes. Additional information.)
   ```
 
   For consistency, there should not be a period at the end of the commit message's summary line (the first line of the commit message).
@@ -29,6 +29,7 @@ Below is a short excerpt of some points in there:
 
   * nginx: init at 2.0.1
   * firefox: 54.0.1 -> 55.0
+    https://www.mozilla.org/en-US/firefox/55.0/releasenotes/
   * nixos/hydra: add bazBaz option
 
     Dual baz behavior is needed to do foo.