nixpkgs/.github/PULL_REQUEST_TEMPLATE.md

## Description of changes

<!--
For package updates please link to a changelog or describe changes, this helps your fellow maintainers discover breaking updates.
For new packages please briefly describe the package or provide a link to its homepage.
-->

## Things done

<!-- Please check what applies. Note that these are not hard requirements but merely serve as information for reviewers. -->

- Built on platform(s)
  - [ ] x86_64-linux
  - [ ] 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)
  - 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://nixos.org/manual/nixpkgs/unstable/#ssec-nixos-tests-linking) 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)
- [ ] Tested basic functionality of all binary files (usually in `./result/bin/`)
- [24.05 Release Notes](https://github.com/NixOS/nixpkgs/blob/master/nixos/doc/manual/release-notes/rl-2405.section.md) (or backporting [23.05](https://github.com/NixOS/nixpkgs/blob/master/nixos/doc/manual/release-notes/rl-2305.section.md) and [23.11](https://github.com/NixOS/nixpkgs/blob/master/nixos/doc/manual/release-notes/rl-2311.section.md) Release notes)
  - [ ] (Package updates) Added a release notes entry if the change is major or breaking
  - [ ] (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).

<!--
To help with the large amounts of pull requests, we would appreciate your
reviews of other pull requests, especially simple package updates. Just leave a
comment describing what you have tested in the relevant package/service.
Reviewing helps to reduce the average time-to-merge for everyone.
Thanks a lot if you do!

List of open PRs: https://github.com/NixOS/nixpkgs/pulls
Reviewing guidelines: https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md#reviewing-contributions
-->

---

Add a :+1: [reaction] to [pull requests you find important].

[reaction]: https://github.blog/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/
[pull requests you find important]: https://github.com/NixOS/nixpkgs/pulls?q=is%3Aopen+sort%3Areactions-%2B1-desc
pr-template: Use semantic H2 level headings The original Markdown ended up being rendered as `<H6>` HTML elements, which is not semantically valid immediately after an `<H1>` element (the PR title). 2023-06-19 04:04:33 +02:00			`## Description of changes`
Update PR template with motivation for changes I'm seeing a lot of PRs that only include the checklist, when the main thing I care about when I'm reviewing a PR is what the author was thinking when they decided to make the change. 2016-05-24 13:59:46 +02:00
PULL_REQUEST_TEMPLATE.md: Request PRs describe themselves There are a lot of PRs for updates that don't make it easy to find out what changes might be breaking and lots of PRs for new packages that don't describe what the new packages is or does. 2022-03-04 16:45:40 +01:00			`<!--`
			`For package updates please link to a changelog or describe changes, this helps your fellow maintainers discover breaking updates.`
			`For new packages please briefly describe the package or provide a link to its homepage.`
			`-->`
Update PR template with motivation for changes I'm seeing a lot of PRs that only include the checklist, when the main thing I care about when I'm reviewing a PR is what the author was thinking when they decided to make the change. 2016-05-24 13:59:46 +02:00
pr-template: Use semantic H2 level headings The original Markdown ended up being rendered as `<H6>` HTML elements, which is not semantically valid immediately after an `<H1>` element (the PR title). 2023-06-19 04:04:33 +02:00			`## Things done`
PULL_REQUEST_TEMPLATE: fix issues raised in 3c84ae406 2016-02-28 10:26:21 +01:00
Pull request template: comment out instructions 2017-08-12 16:17:39 +02:00			`<!-- Please check what applies. Note that these are not hard requirements but merely serve as information for reviewers. -->`
Pull request template: clarify the purpose of the template 2017-07-22 18:04:19 +02:00
.github/PULL_REQUEST_TEMPLATE.md: use individual checkboxes for tested OSes 2016-03-16 09:46:05 +01:00			`- Built on platform(s)`
PULL_REQUEST_TEMPLATE.md: Improve platform checkboxes 1) Building with the sandbox enabled is the standard on Linux, so it is of little relevance with distribution they are using. Because of this, we now specify "Linux" instead of "NixOS", and the sandbox checkbox specifies "non-Linux". 2) aarch64 is a much more common platform, so we add two separate checkboxes for both aarch64-linux and aarch64-darwin. 3) The platform names now match what is actually used by Nix. 2021-08-14 13:39:46 +02:00			`- [ ] x86_64-linux`
			`- [ ] aarch64-linux`
			`- [ ] x86_64-darwin`
			`- [ ] aarch64-darwin`
PULL_REQUEST_TEMPLATE.md: Update sandboxing check Update the sandboxing check to include the `relaxed` setting for sandboxing. Previously there was no obvious and correct way to convey this intermediate setting between sandboxing being completely disabled and being enforced strictly. 2023-06-19 14:35:52 +02:00			- 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`
PULL_REQUEST_TEMPLATE.md: Elaborate on testing We've recently seen VM tests being added that could have been simple package tests instead. 2021-10-31 20:56:30 +01:00			`- [ ] Tested, as applicable:`
PULL_REQUEST_TEMPLATE.md: ticks to bullets As suggested by 06kellyjac. 2021-11-03 18:16:41 +01:00			`- [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))`
PULL_REQUEST_TEMPLATE.md: Update link to package tests 2024-04-03 20:28:06 +02:00			`- and/or [package tests](https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md#package-tests)`
PULL_REQUEST_TEMPLATE.md: ticks to bullets As suggested by 06kellyjac. 2021-11-03 18:16:41 +01:00			`- 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://nixos.org/manual/nixpkgs/unstable/#ssec-nixos-tests-linking) to the relevant packages`
PULL_REQUEST_TEMPLATE.md: change nixpkgs-review wip to rev HEAD 2021-11-10 18:24:34 +01:00			- [ ] 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)
PULL_REQUEST_TEMPLATE.md: execution -> basic functionality As suggested by Artturin. 2021-11-01 00:15:21 +01:00			- [ ] Tested basic functionality of all binary files (usually in `./result/bin/`)
{CONTRIBUTING,PULL_REQUEST_TEMPLATE}.md: update NixOS release 2023-11-26 18:01:20 +01:00			`- [24.05 Release Notes](https://github.com/NixOS/nixpkgs/blob/master/nixos/doc/manual/release-notes/rl-2405.section.md) (or backporting [23.05](https://github.com/NixOS/nixpkgs/blob/master/nixos/doc/manual/release-notes/rl-2305.section.md) and [23.11](https://github.com/NixOS/nixpkgs/blob/master/nixos/doc/manual/release-notes/rl-2311.section.md) Release notes)`
pull_request_template: Add release note criteria 2021-06-02 22:21:56 +02:00			`- [ ] (Package updates) Added a release notes entry if the change is major or breaking`
			`- [ ] (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`
CONTRIBUTING.md: Move to repo root, where it is more visible. We found that many users found it difficult to locate this document. Github supports it in the root, see: https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors 2021-06-26 04:37:39 +02:00			`- [ ] Fits [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md).`
PULL_REQUEST_TEMPLATE: move call-for-review to the end This improves URL previews like the ones on Discourse, where currently the boilerplate comment is printed for every PR link instead of parts of the motivation. 2022-03-07 19:55:42 +01:00
			`<!--`
			`To help with the large amounts of pull requests, we would appreciate your`
			`reviews of other pull requests, especially simple package updates. Just leave a`
			`comment describing what you have tested in the relevant package/service.`
			`Reviewing helps to reduce the average time-to-merge for everyone.`
			`Thanks a lot if you do!`

			`List of open PRs: https://github.com/NixOS/nixpkgs/pulls`
PULL_REQUEST_TEMPLATE: update link to reviewing contribution 2024-03-23 12:25:37 +01:00			`Reviewing guidelines: https://github.com/NixOS/nixpkgs/blob/master/pkgs/README.md#reviewing-contributions`
PULL_REQUEST_TEMPLATE: move call-for-review to the end This improves URL previews like the ones on Discourse, where currently the boilerplate comment is printed for every PR link instead of parts of the motivation. 2022-03-07 19:55:42 +01:00			`-->`
Encourage +1's for prioritisation Adds a small text to each issue and the PR template to encourage people to use :+1:'s for issues they're also interested in. See https://github.com/NixOS/nix.dev/issues/359 for more information Co-Authored-By: Valentin Gagarin <valentin.gagarin@tweag.io> 2023-11-21 07:00:18 +01:00
.github: removing "Priorities" heading Where this was a markdown heading, it sometimes had the wrong weight so it appeared as if it was a subheading of the previous section, and some people feel the word "Priorities" creates misleading expectations. Link: https://github.com/NixOS/nixpkgs/pull/203969/files#r1037761779 2023-11-21 20:36:04 +01:00			`---`
Encourage +1's for prioritisation Adds a small text to each issue and the PR template to encourage people to use :+1:'s for issues they're also interested in. See https://github.com/NixOS/nix.dev/issues/359 for more information Co-Authored-By: Valentin Gagarin <valentin.gagarin@tweag.io> 2023-11-21 07:00:18 +01:00
			`Add a :+1: [reaction] to [pull requests you find important].`

			`[reaction]: https://github.blog/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/`
			`[pull requests you find important]: https://github.com/NixOS/nixpkgs/pulls?q=is%3Aopen+sort%3Areactions-%2B1-desc`