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. -->

- [ ] Tested using sandboxing ([nix.useSandbox](https://nixos.org/nixos/manual/options.html#opt-nix.useSandbox) on NixOS, or option `sandbox` in [`nix.conf`](https://nixos.org/nix/manual/#sec-conf-file) on non-NixOS linux)
- Built on platform(s)
   - [ ] NixOS
   - [ ] macOS
   - [ ] other Linux distributions
- [ ] 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 packages 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/`)
- [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
- [ ] 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 09:31:39 +02: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 01:18:19 +01: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 09:31:39 +02: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 13:59:46 +02: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 18:53:24 +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
treewide: use https for nixos.org and hydra.nixos.org tarballs.nixos.org is omitted from the change because urls from there are always hashed and checked 2020-04-18 22:51:19 +02:00			- [ ] Tested using sandboxing ([nix.useSandbox](https://nixos.org/nixos/manual/options.html#opt-nix.useSandbox) on NixOS, or option `sandbox` in [`nix.conf`](https://nixos.org/nix/manual/#sec-conf-file) on non-NixOS linux)
.github/PULL_REQUEST_TEMPLATE.md: use individual checkboxes for tested OSes 2016-03-16 09:46:05 +01:00			`- Built on platform(s)`
			`- [ ] NixOS`
Update PULL_REQUEST_TEMPLATE.md Follow the rebranding of OS X into macOS 2016-11-04 16:49:40 +01:00			`- [ ] macOS`
pr template: make values of platform field less ambiguous 2017-10-09 12:47:59 +02:00			`- [ ] other Linux distributions`
github/pr-template: Add note about NixOS tests On several occasions I've seen people bumping packages which have NixOS tests but without actually running them. While this probably won't prevent such occasions entirely, at least it serves as an additional checklist item so contributors don't forget about these tests. Signed-off-by: aszlig <aszlig@redmoonstudios.org> 2017-06-23 05:33:06 +02:00			`- [ ] 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))`
doc: fix typo and wording in pull request template 2021-08-05 16:45:09 +02:00			- [ ] Tested compilation of all packages that depend on this change using `nix-shell -p nixpkgs-review --run "nixpkgs-review wip"`
PULL_REQUEST_TEMPLATE.md: clarify a few things 2016-02-28 09:49:55 +01:00			- [ ] Tested execution of all binary files (usually in `./result/bin/`)
doc: fix typo and wording in pull request template 2021-08-05 16:45:09 +02: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 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).`