nixpkgs/.github/PULL_REQUEST_TEMPLATE.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://nixos.org/manual/nixpkgs/unstable/#chap-reviewing-contributions
-->

###### Motivation for this change


###### 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 `sandbox = true` set in `nix.conf`? (See [Nix manual](https://nixos.org/manual/nix/stable/command-ref/conf-file.html))
- [ ] 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://nixos.org/manual/nixpkgs/unstable/#sec-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/`)
- [21.11 Release Notes (or backporting 21.05 Release notes)](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md#generating-2111-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
  - [ ] (Release notes changes) Ran `nixos/doc/manual/md-to-db.sh` to update generated release notes
- [ ] Fits [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md).
PULL_REQUEST_TEMPLATE: try to simplify call-for-review The text is quite long and hard to read in hub (because it is one whole line with no line breaks). Also simplified the language/sentence structure a bit for non-native speakers. 2020-04-27 07:31:39 +00: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.md: use rendered docs 2020-11-14 00:18:19 +00:00			`Reviewing guidelines: https://nixos.org/manual/nixpkgs/unstable/#chap-reviewing-contributions`
PULL_REQUEST_TEMPLATE: try to simplify call-for-review The text is quite long and hard to read in hub (because it is one whole line with no line breaks). Also simplified the language/sentence structure a bit for non-native speakers. 2020-04-27 07:31:39 +00:00			`-->`

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 11:59:46 +00:00			`###### Motivation for this change`


Simplify contributing * Highlight the top mistakes directly in CONTRIBUTING.md * Remove unecessary cruft from the PR template 2016-04-09 16:53:24 +00:00			`###### Things done`
PULL_REQUEST_TEMPLATE: fix issues raised in 3c84ae406 2016-02-28 09:26:21 +00:00
Pull request template: comment out instructions 2017-08-12 14:17:39 +00: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 16:04:19 +00:00
.github/PULL_REQUEST_TEMPLATE.md: use individual checkboxes for tested OSes 2016-03-16 08:46:05 +00: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 11:39:46 +00:00			`- [ ] x86_64-linux`
			`- [ ] aarch64-linux`
			`- [ ] x86_64-darwin`
			`- [ ] aarch64-darwin`
PULL_REQUEST_TEMPLATE.md: fix link to nix.conf documentation 2021-11-20 01:07:02 +00:00			- [ ] For non-Linux: Is `sandbox = true` set in `nix.conf`? (See [Nix manual](https://nixos.org/manual/nix/stable/command-ref/conf-file.html))
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 19:56:30 +00:00			`- [ ] Tested, as applicable:`
PULL_REQUEST_TEMPLATE.md: ticks to bullets As suggested by 06kellyjac. 2021-11-03 17:16:41 +00: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))`
			`- and/or [package tests](https://nixos.org/manual/nixpkgs/unstable/#sec-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`
PULL_REQUEST_TEMPLATE.md: change nixpkgs-review wip to rev HEAD 2021-11-10 17:24:34 +00: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-10-31 23:15:21 +00:00			- [ ] Tested basic functionality of all binary files (usually in `./result/bin/`)
doc: fix typo and wording in pull request template 2021-08-05 14:45:09 +00:00			`- [21.11 Release Notes (or backporting 21.05 Release notes)](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md#generating-2111-release-notes)`
pull_request_template: Add release note criteria 2021-06-02 20:21:56 +00: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`
.github/PULL_REQUEST_TEMPLATE: added md-to-db reminder 2021-10-15 23:26:47 +00:00			- [ ] (Release notes changes) Ran `nixos/doc/manual/md-to-db.sh` to update generated release notes
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 02:37:39 +00:00			`- [ ] Fits [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/CONTRIBUTING.md).`