nixpkgs/.github/PULL_REQUEST_TEMPLATE.md

<!-- Nixpkgs has a lot of new incoming Pull Requests, but not enough people to review this constant stream. Even if you aren't a committer, we would appreciate reviews of other PRs, especially simple ones like package updates. Just testing the relevant package/service and leaving a comment saying what you tested, how you tested it and whether it worked would be great. List of open PRs: <https://github.com/NixOS/nixpkgs/pulls>, for more about reviewing contributions: <https://hydra.nixos.org/job/nixpkgs/trunk/manual/latest/download/1/nixpkgs/manual.html#chap-reviewing-contributions>. Reviewing isn't mandatory, but it would help out a lot and reduce the average time-to-merge for all of us. Thanks a lot if you do! -->
###### 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](http://nixos.org/nixos/manual/options.html#opt-nix.useSandbox) on NixOS, or option `sandbox` in [`nix.conf`](http://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 pkgs that depend on this change using `nix-shell -p nix-review --run "nix-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
- [ ] Fits [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/.github/CONTRIBUTING.md).

###### Notify maintainers

cc @
Fix link in PULL_REQUEST_TEMPLATE.md (the same link) 2019-10-28 18:05:22 +00:00			<!-- Nixpkgs has a lot of new incoming Pull Requests, but not enough people to review this constant stream. Even if you aren't a committer, we would appreciate reviews of other PRs, especially simple ones like package updates. Just testing the relevant package/service and leaving a comment saying what you tested, how you tested it and whether it worked would be great. List of open PRs: <https://github.com/NixOS/nixpkgs/pulls>, for more about reviewing contributions: <https://hydra.nixos.org/job/nixpkgs/trunk/manual/latest/download/1/nixpkgs/manual.html#chap-reviewing-contributions>. Reviewing isn't mandatory, but it would help out a lot and reduce the average time-to-merge for all of us. Thanks a lot if you do! -->
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 12:59:46 +01: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 17:53:24 +01: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 15:17:39 +01: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 17:04:19 +01:00
.github: clarify things done re: sandboxing Per https://github.com/NixOS/nixpkgs/pull/58147#issuecomment-478234495 sandboxing is not fully functional on macOS. .github: specify where sandboxing can be run Co-Authored-By: Jon <jonringer@users.noreply.github.com> .github: remove macOS note 2019-10-28 22:05:29 +00:00			- [ ] Tested using sandboxing ([nix.useSandbox](http://nixos.org/nixos/manual/options.html#opt-nix.useSandbox) on NixOS, or option `sandbox` in [`nix.conf`](http://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 08:46:05 +00:00			`- Built on platform(s)`
			`- [ ] NixOS`
Update PULL_REQUEST_TEMPLATE.md Follow the rebranding of OS X into macOS 2016-11-04 15:49:40 +00:00			`- [ ] macOS`
pr template: make values of platform field less ambiguous 2017-10-09 11:47:59 +01: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 04:33:06 +01: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/reviewing-contributions: nix-review instead of nox-review It is faster, handles more edge cases and allows to test/review the built packages interactively. 2019-03-08 14:17:28 +00:00			- [ ] Tested compilation of all pkgs that depend on this change using `nix-shell -p nix-review --run "nix-review wip"`
PULL_REQUEST_TEMPLATE.md: clarify a few things 2016-02-28 08:49:55 +00:00			- [ ] Tested execution of all binary files (usually in `./result/bin/`)
PULL_REQUEST_TEMPLATE.md: Ask for closure size impact 2018-06-21 17:51:45 +01:00			- [ ] Determined the impact on package closure size (by running `nix path-info -S` before and after)
PULL_REQUEST_TEMPLATE: "Assured whether" -> "Ensured that" 2019-07-01 11:22:48 +01:00			`- [ ] Ensured that relevant documentation is up to date`
PULL_REQUEST_TEMPLATE: init 2016-02-18 16:26:17 +00:00			`- [ ] Fits [CONTRIBUTING.md](https://github.com/NixOS/nixpkgs/blob/master/.github/CONTRIBUTING.md).`

PULL_REQUEST_TEMPLATE: Add "Notify maintainers" section 2019-07-29 23:34:49 +01:00			`###### Notify maintainers`

			`cc @`