Merge pull request #200922 from NixOS/contributing-pkg-bump-rls-notes

CONTRIBUTING: Package bumps should reference release notes
This commit is contained in:
piegames 2022-11-16 21:44:58 +01:00 committed by GitHub
commit 649c01e3f1
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -51,7 +51,7 @@ See the nixpkgs manual for more details on [standard meta-attributes](https://ni
In addition to writing properly formatted commit messages, it's important to include relevant information so other developers can later understand *why* a change was made. While this information usually can be found by digging code, mailing list/Discourse archives, pull request discussions or upstream changes, it may require a lot of work.
For package version upgrades and such a one-line commit message is usually sufficient.
Package version upgrades usually allow for simpler commit messages, including attribute name, old and new version, as well as a reference to the relevant release notes/changelog. Every once in a while a package upgrade requires more extensive changes, and that subsequently warrants a more verbose message.
## Rebasing between branches (i.e. from master to staging)