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.
This commit is contained in:
Martin Weinelt 2022-04-05 04:22:07 +02:00
parent fb968e0869
commit cd00cafaad
No known key found for this signature in database
GPG Key ID: 87C1E9888F856759

View File

@ -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.