From cd00cafaaddb06e4b7075e0ca1562dd8610a9e7a Mon Sep 17 00:00:00 2001 From: Martin Weinelt Date: Tue, 5 Apr 2022 04:22:07 +0200 Subject: [PATCH] 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. --- CONTRIBUTING.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0f8b5faef12..b90598e6791 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -20,7 +20,7 @@ Below is a short excerpt of some points in there: ``` (pkg-name | nixos/): (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.