From 2f8b917c22be8a51a756793bd7944e880aef196b Mon Sep 17 00:00:00 2001 From: Gwenn Le Bihan Date: Mon, 26 May 2025 14:49:53 +0200 Subject: [PATCH] doc: mention adding maintainers must be done in a separate commit (#410292) --- maintainers/README.md | 4 ++++ pkgs/README.md | 2 ++ 2 files changed, 6 insertions(+) diff --git a/maintainers/README.md b/maintainers/README.md index 7f5b6ee6fcb6..2759b0aa7dc1 100644 --- a/maintainers/README.md +++ b/maintainers/README.md @@ -40,6 +40,10 @@ In order to do so, add yourself to the [`maintainer-list.nix`](./maintainer-list.nix), and then to the desired package's `meta.maintainers` list, and send a PR with the changes. +If you're adding yourself as a maintainer as part of another PR (in which +you become a maintainer of a package, for example), make your change to +`maintainer-list.nix` in a separate commit. + ### How to lose maintainer status Maintainers who have become inactive on a given package can be removed. This diff --git a/pkgs/README.md b/pkgs/README.md index 878db5df8397..bcadafd73f0a 100644 --- a/pkgs/README.md +++ b/pkgs/README.md @@ -113,6 +113,8 @@ Now that this is out of the way. To add a package to Nixpkgs: - Add yourself as the maintainer of the package. + - If this is your first time contributing (welcome!), [add yourself to the maintainers list](../maintainers/README.md#how-to-become-a-maintainer) in a separate commit. + - All other [`meta`](https://nixos.org/manual/nixpkgs/stable/#chap-meta) attributes are optional, but it’s still a good idea to provide at least the `description`, `homepage` and [`license`](https://nixos.org/manual/nixpkgs/stable/#sec-meta-license). - The exact syntax and semantics of the Nix expression language, including the built-in functions, are [Nix language reference](https://nixos.org/manual/nix/stable/language/).