summary refs log tree commit diff
path: root/.github/PULL_REQUEST_TEMPLATE.md
diff options
context:
space:
mode:
authorLéo Gaspard <leo@gaspard.io>2021-05-21 03:06:21 +0200
committerGitHub <noreply@github.com>2021-05-21 03:06:21 +0200
commit211fee9c4379714d861b3c875f642addbd25e920 (patch)
tree3d525ba7eaa63a4d11687358a445e3ebe8ebd8f7 /.github/PULL_REQUEST_TEMPLATE.md
parent6bad8a5633d6c485c37b169905048b6cd365a67b (diff)
pull request template: cleanup (#117537)
Remove elements of the PR template that have a low signal/noise ratio,
and add one that I think would have a good signal/noise ratio.

-----
Remove:
Determined the impact on package closure size (by running `nix path-info
-S` before and after)
-----
Rationale:
This is rarely done in practice, and apart from for specific packages
this is usually not a good indicator of anything useful

It might make sense to re-introduce it with two holes to fill, but then
we would have to make a serious decision to never land without these two
numbers filled in or with too big a regression, because in practice this
box has been a no-op in many cases.

Maybe just integrating this check in nixpkgs-review would bring the most
benefit here?
-----

-----
Remove:
Ensured that relevant documentation is up to date
-----
Rationale:
This is fuzzy, “relevant documentation” is way too often hard to find
-----

-----
Add:
Added a release notes entry if the change is major or breaking
-----
Rationale:
This is way too often forgotten, and is also a self-contained easy task
-----
Diffstat (limited to '.github/PULL_REQUEST_TEMPLATE.md')
-rw-r--r--.github/PULL_REQUEST_TEMPLATE.md3
1 files changed, 1 insertions, 2 deletions
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
index ce630e77e940c..737834320378f 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -23,6 +23,5 @@ Reviewing guidelines: https://nixos.org/manual/nixpkgs/unstable/#chap-reviewing-
 - [ ] Tested via one or more NixOS test(s) if existing and applicable for the change (look inside [nixos/tests](https://github.com/NixOS/nixpkgs/blob/master/nixos/tests))
 - [ ] Tested compilation of all pkgs that depend on this change using `nix-shell -p nixpkgs-review --run "nixpkgs-review wip"`
 - [ ] Tested execution of all binary files (usually in `./result/bin/`)
-- [ ] Determined the impact on package closure size (by running `nix path-info -S` before and after)
-- [ ] Ensured that relevant documentation is up to date
+- [ ] Added a release notes entry if the change is major or breaking
 - [ ] Fits [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/.github/CONTRIBUTING.md).