From d61ece5a95ce92a08b9d7b42568fbacc06ee52d5 Mon Sep 17 00:00:00 2001 From: Wolfgang Walther Date: Wed, 16 Jul 2025 17:55:14 +0200 Subject: [PATCH 1/5] .github/PULL_REQUEST_TEMPLATE: remove sandbox checkbox This checkbox has been used very incosistently and its meaning is not entirely clear: What does it mean if both checkboxes are *unchecked*? Does that mean the sandbox was disabled? Or does it mean the checkbox was just not handled? Also the new nixpkgs-review-gha, which is increasingly used to test builds on darwin platforms shows this information as part of the review - where it's in a much better place. --- .github/PULL_REQUEST_TEMPLATE.md | 3 --- 1 file changed, 3 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index db78d5188521..4f5365b11d5b 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -15,9 +15,6 @@ For new packages please briefly describe the package or provide a link to its ho - [ ] aarch64-linux - [ ] x86_64-darwin - [ ] aarch64-darwin -- For non-Linux: Is sandboxing enabled in `nix.conf`? (See [Nix manual](https://nixos.org/manual/nix/stable/command-ref/conf-file.html)) - - [ ] `sandbox = relaxed` - - [ ] `sandbox = true` - [ ] Tested, as applicable: - [NixOS test(s)](https://nixos.org/manual/nixos/unstable/index.html#sec-nixos-tests) (look inside [nixos/tests](https://github.com/NixOS/nixpkgs/blob/master/nixos/tests)) - and/or [package tests](https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md#package-tests) From 0d433c5f7e0af87d9d50292689e7ec595f651348 Mon Sep 17 00:00:00 2001 From: Wolfgang Walther Date: Wed, 16 Jul 2025 17:58:00 +0200 Subject: [PATCH 2/5] .github/PULL_REQUEST_TEMPLATE: remove note about reviews While this note is important, it's also mostly invisible at this stage. The comment only shows while creating the PR, but at this stage the author really has other things to worry about. If they care, they will read the contribution guidelines and will pick up the pieces about reviewing that way. If they don't - they won't be bothered by this notice either. --- .github/PULL_REQUEST_TEMPLATE.md | 11 ----------- 1 file changed, 11 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 4f5365b11d5b..4645b429ba12 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -29,17 +29,6 @@ For new packages please briefly describe the package or provide a link to its ho - [ ] (Module addition) Added a release notes entry if adding a new NixOS module - [ ] Fits [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md), [pkgs/README.md](https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md), [maintainers/README.md](https://github.com/NixOS/nixpkgs/blob/master/maintainers/README.md) and other contributing documentation in corresponding paths. - - --- Add a :+1: [reaction] to [pull requests you find important]. From 76dd297d04ace8708199130c4df5812afbd740bc Mon Sep 17 00:00:00 2001 From: Wolfgang Walther Date: Wed, 16 Jul 2025 18:08:26 +0200 Subject: [PATCH 3/5] .github/PULL_REQUEST_TEMPLATE: avoid inlining links for readability We expect the TODO list to be read through *on PR creation*, otherwise the html comments would not make sense. Thus, we should make it even only slightly readable, which was not at all the case before. The links for release notes are removed, because the PR author has no value from the *current* release notes. They will need to find the file manually anyway. --- .github/PULL_REQUEST_TEMPLATE.md | 28 ++++++++++++++++++++-------- 1 file changed, 20 insertions(+), 8 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 4645b429ba12..101d066850e9 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -16,18 +16,30 @@ For new packages please briefly describe the package or provide a link to its ho - [ ] x86_64-darwin - [ ] aarch64-darwin - [ ] Tested, as applicable: - - [NixOS test(s)](https://nixos.org/manual/nixos/unstable/index.html#sec-nixos-tests) (look inside [nixos/tests](https://github.com/NixOS/nixpkgs/blob/master/nixos/tests)) - - and/or [package tests](https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md#package-tests) - - or, for functions and "core" functionality, tests in [lib/tests](https://github.com/NixOS/nixpkgs/blob/master/lib/tests) or [pkgs/test](https://github.com/NixOS/nixpkgs/blob/master/pkgs/test) - - made sure NixOS tests are [linked](https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md#linking-nixos-module-tests-to-a-package) to the relevant packages -- [ ] Tested compilation of all packages that depend on this change using `nix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD"`. Note: all changes have to be committed, also see [nixpkgs-review usage](https://github.com/Mic92/nixpkgs-review#usage) + - [NixOS test(s)] (look inside [nixos/tests]) + - and/or [package tests] + - or, for functions and "core" functionality, tests in [lib/tests] or [pkgs/test] + - made sure NixOS tests are [linked] to the relevant packages +- [ ] Tested compilation of all packages that depend on this change using `nix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD"`. Note: all changes have to be committed, also see [nixpkgs-review usage] - [ ] Tested basic functionality of all binary files (usually in `./result/bin/`) -- [Nixpkgs 25.11 Release Notes](https://github.com/NixOS/nixpkgs/blob/master/doc/release-notes/rl-2511.section.md) (or backporting [25.05](https://github.com/NixOS/nixpkgs/blob/master/doc/manual/release-notes/rl-2505.section.md) Nixpkgs Release notes) +- Nixpkgs Release Notes (or backporting 25.05 Nixpkgs Release notes) - [ ] (Package updates) Added a release notes entry if the change is major or breaking -- [NixOS 25.11 Release Notes](https://github.com/NixOS/nixpkgs/blob/master/nixos/doc/manual/release-notes/rl-2511.section.md) (or backporting [25.05](https://github.com/NixOS/nixpkgs/blob/master/nixos/doc/manual/release-notes/rl-2505.section.md) NixOS Release notes) +- NixOS Release Notes (or backporting 25.05 NixOS Release notes) - [ ] (Module updates) Added a release notes entry if the change is significant - [ ] (Module addition) Added a release notes entry if adding a new NixOS module -- [ ] Fits [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md), [pkgs/README.md](https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md), [maintainers/README.md](https://github.com/NixOS/nixpkgs/blob/master/maintainers/README.md) and other contributing documentation in corresponding paths. +- [ ] Fits [CONTRIBUTING.md], [pkgs/README.md], [maintainers/README.md] and other contributing documentation in corresponding paths. + +[NixOS test(s)]: https://nixos.org/manual/nixos/unstable/index.html#sec-nixos-tests +[package tests]: https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md#package-tests +[linked]: https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md#linking-nixos-module-tests-to-a-package +[nixpkgs-review usage]: https://github.com/Mic92/nixpkgs-review#usage + +[CONTRIBUTING.md]: https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md +[lib/tests]: https://github.com/NixOS/nixpkgs/blob/master/lib/tests +[maintainers/README.md]: https://github.com/NixOS/nixpkgs/blob/master/maintainers/README.md +[nixos/tests]: https://github.com/NixOS/nixpkgs/blob/master/nixos/tests +[pkgs/README.md]: https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md +[pkgs/test]: https://github.com/NixOS/nixpkgs/blob/master/pkgs/test --- From 464e0012d45dd251c579869d43ec9231bb9e9720 Mon Sep 17 00:00:00 2001 From: Wolfgang Walther Date: Wed, 16 Jul 2025 18:15:16 +0200 Subject: [PATCH 4/5] .github/PULL_REQUEST_TEMPLATE: remove mention of linking NixOS tests This *is* important, but is a niche detail which belongs into the contributions guidelines - and not into the PR template. It's also out of place for "what did you test?". --- .github/PULL_REQUEST_TEMPLATE.md | 2 -- 1 file changed, 2 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 101d066850e9..e0cb5210e5a5 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -19,7 +19,6 @@ For new packages please briefly describe the package or provide a link to its ho - [NixOS test(s)] (look inside [nixos/tests]) - and/or [package tests] - or, for functions and "core" functionality, tests in [lib/tests] or [pkgs/test] - - made sure NixOS tests are [linked] to the relevant packages - [ ] Tested compilation of all packages that depend on this change using `nix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD"`. Note: all changes have to be committed, also see [nixpkgs-review usage] - [ ] Tested basic functionality of all binary files (usually in `./result/bin/`) - Nixpkgs Release Notes (or backporting 25.05 Nixpkgs Release notes) @@ -31,7 +30,6 @@ For new packages please briefly describe the package or provide a link to its ho [NixOS test(s)]: https://nixos.org/manual/nixos/unstable/index.html#sec-nixos-tests [package tests]: https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md#package-tests -[linked]: https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md#linking-nixos-module-tests-to-a-package [nixpkgs-review usage]: https://github.com/Mic92/nixpkgs-review#usage [CONTRIBUTING.md]: https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md From 7288dfa6c20433fcd57201943d1acee86f46c64a Mon Sep 17 00:00:00 2001 From: Wolfgang Walther Date: Wed, 16 Jul 2025 18:20:50 +0200 Subject: [PATCH 5/5] .github/PULL_REQUEST_TEMPLATE: shorten TODO list This doesn't really change the items, but shortens the writing a lot, making them much more readable, especially while still drafting the PR. Mentioning the release notes for the previous release is not really important, because it doesn't apply for the big majority of pull requests. --- .github/PULL_REQUEST_TEMPLATE.md | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index e0cb5210e5a5..6f2f01e5d33e 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -10,26 +10,26 @@ For new packages please briefly describe the package or provide a link to its ho -- Built on platform(s) +- Built on platform: - [ ] x86_64-linux - [ ] aarch64-linux - [ ] x86_64-darwin - [ ] aarch64-darwin -- [ ] Tested, as applicable: - - [NixOS test(s)] (look inside [nixos/tests]) - - and/or [package tests] - - or, for functions and "core" functionality, tests in [lib/tests] or [pkgs/test] -- [ ] Tested compilation of all packages that depend on this change using `nix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD"`. Note: all changes have to be committed, also see [nixpkgs-review usage] -- [ ] Tested basic functionality of all binary files (usually in `./result/bin/`) -- Nixpkgs Release Notes (or backporting 25.05 Nixpkgs Release notes) - - [ ] (Package updates) Added a release notes entry if the change is major or breaking -- NixOS Release Notes (or backporting 25.05 NixOS Release notes) - - [ ] (Module updates) Added a release notes entry if the change is significant - - [ ] (Module addition) Added a release notes entry if adding a new NixOS module -- [ ] Fits [CONTRIBUTING.md], [pkgs/README.md], [maintainers/README.md] and other contributing documentation in corresponding paths. +- Tested, as applicable: + - [ ] [NixOS tests] in [nixos/tests]. + - [ ] [Package tests] at `passthru.tests`. + - [ ] Tests in [lib/tests] or [pkgs/test] for functions and "core" functionality. +- [ ] Ran `nixpkgs-review` on this PR. See [nixpkgs-review usage]. +- [ ] Tested basic functionality of all binary files, usually in `./result/bin/`. +- Nixpkgs Release Notes + - [ ] Package update: when the change is major or breaking. +- NixOS Release Notes + - [ ] Module addition: when adding a new NixOS module. + - [ ] Module update: when the change is significant. +- [ ] Fits [CONTRIBUTING.md], [pkgs/README.md], [maintainers/README.md] and others READMEs. -[NixOS test(s)]: https://nixos.org/manual/nixos/unstable/index.html#sec-nixos-tests -[package tests]: https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md#package-tests +[NixOS tests]: https://nixos.org/manual/nixos/unstable/index.html#sec-nixos-tests +[Package tests]: https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md#package-tests [nixpkgs-review usage]: https://github.com/Mic92/nixpkgs-review#usage [CONTRIBUTING.md]: https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md