From aa25691630cb54c5c3d261198cb838bbce2afb5c Mon Sep 17 00:00:00 2001 From: Matthias Beyer Date: Tue, 8 Aug 2023 21:58:55 +0200 Subject: [PATCH] CONTRIBUTING: Add note about how to commit new maintainers-list.nix entry Signed-off-by: Matthias Beyer --- CONTRIBUTING.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 177e6a4a687e..616fd4c22013 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -535,6 +535,11 @@ To get a sense for what changes are considered mass rebuilds, see [previously me The old config generation system used impure shell scripts and could break in specific circumstances (see #1234). + When adding yourself as maintainer, in the same pull request, make a separate + commit with the message `maintainers: add `. + Add the commit before those making changes to the package or module. + See [Nixpkgs Maintainers](../maintainers/README.md) for details. + ### Writing good commit messages 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.