Commit Graph

37 Commits

Author SHA1 Message Date
Niklas Hambüchen 3c29ced243 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:51:38 +02:00
Ryan Mulligan f91d7910ea doc: cleanup documentation relating to release notes
Also delete empty release notes file.
2021-06-23 11:04:22 -07:00
Pavol Rusnak 576c2f555e pull_request_template: fix link to CONTRIBUTING.md 2021-06-05 08:27:10 -07:00
Jonathan Ringer 291dcac830
pull_request_template: Add release note criteria 2021-06-02 13:37:14 -07:00
Léo Gaspard 211fee9c43
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
-----
2021-05-21 03:06:21 +02:00
Jonathan Ringer 698c471340
PULL_REQUEST_TEMPLATE.md: use rendered docs 2020-11-13 16:18:19 -08:00
Pavol Rusnak 7b0167204d 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-05-03 22:14:21 -07:00
Jörg Thalheim 93862d05f7
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 22:07:19 +01:00
Ingolf Wagner d9bbc22cef
.github: remove cc from pull-request template 2020-01-03 15:58:31 +13:00
Jörg Thalheim 8a57552c18
nixpkgs-review: 2.1.0 -> 2.1.1
changelog: https://github.com/Mic92/nixpkgs-review/releases/tag/2.1.1
2019-12-22 09:26:57 +00:00
Americo 5c59da48e4
.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-30 11:32:29 -07:00
Vladimír Čunát 3c5f5b1cde Fix link in PULL_REQUEST_TEMPLATE.md (the same link) 2019-10-28 19:25:05 +01:00
Steven Shaw e2a28e8dd2 PULL_REQUEST_TEMPLATE: Add "Notify maintainers" section 2019-07-30 08:36:16 +02:00
Craig Hall d096030d07
PULL_REQUEST_TEMPLATE: "Assured whether" -> "Ensured that" 2019-07-01 11:22:48 +01:00
worldofpeace 1d38a2f5c3
Merge pull request #58098 from Infinisil/encouraging_reviews
PULL_REQUEST_TEMPLATE: Add encouragement to review PRs
2019-04-04 17:14:18 -04:00
Silvan Mosberger 4e398a325e
PULL_REQUEST_TEMPLATE: Add encouragement to review PRs 2019-03-28 21:18:46 +01:00
Jörg Thalheim 22d083e659
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-20 11:28:00 +00:00
Niklas Hambüchen f2816e47ab PULL_REQUEST_TEMPLATE: Ask for docs 2018-11-22 19:57:19 +01:00
Eelco Dolstra bf1c28e978
PULL_REQUEST_TEMPLATE.md: Ask for closure size impact 2018-06-21 18:52:26 +02:00
Bob van der Linden b503e76ee0
use sandbox instead of build-use-sandbox 2018-05-30 21:48:07 +02:00
Maxime Dénès 9ca1b56683
pr template: make values of platform field less ambiguous 2017-10-09 12:53:09 +02:00
Piotr Bogdan e221d945ad pr template: make formatting consistent 2017-09-03 19:57:18 +01:00
Linus Heckemann 02d168e130 Pull request template: comment out instructions 2017-08-12 15:17:39 +01:00
Yegor Timoshenko 72239c3a22 PULL_REQUEST_TEMPLATE.md: mereley -> merely 2017-07-28 23:38:25 +00:00
Frederik Rietdijk 138eba0bff Pull request template: clarify the purpose of the template 2017-07-22 18:05:16 +02:00
aszlig fa6fd34fcc
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
Ignat Loskutov d91eba4ec3 Update PULL_REQUEST_TEMPLATE.md
Follow the rebranding of OS X into macOS
2016-11-04 18:49:40 +03:00
Rushmore Mushambi 0192777972 PULL_REQUEST_TEMPLATE: rename chroot to sandbox
See b39622a487
2016-09-02 21:41:43 +02:00
Vladimír Čunát 156105c489 PR template: go back to old option name for now
The old one works on all nix(os) versions, whereas the new one doesn't
work e.g. on default 16.03 setting. Discussed on #15112.
2016-06-29 21:44:05 +02:00
Daniel Peebles 0bd54a6d5d 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 07:59:46 -04:00
Vladimír Čunát 4c10d404e7 github PR template: reformulate the sandboxing help
It's been reported that when running through nix daemon,
sandboxing can't be turned on by passing `--option` (silently ignored),
so let's not suggest that way.
https://github.com/NixOS/nixpkgs/issues/14866#issuecomment-214619909
2016-04-26 09:18:15 +02:00
Vladimír Čunát 7cf8daa2bb nixos: rename chroot* to sandbox*
On Nix side this was done months ago:
https://github.com/NixOS/nix/pull/682
2016-04-25 11:04:08 +02:00
zimbatm 8706726d59 Simplify contributing
* Highlight the top mistakes directly in CONTRIBUTING.md
* Remove unecessary cruft from the PR template
2016-04-09 17:59:35 +01:00
Nathan Zadoks d0b8080062 .github/PULL_REQUEST_TEMPLATE.md: use individual checkboxes for tested OSes 2016-03-16 09:46:05 +01:00
Domen Kožar 2af46e4393 PULL_REQUEST_TEMPLATE: fix issues raised in 3c84ae406 2016-02-28 09:26:28 +00:00
Domen Kožar 3c84ae406d PULL_REQUEST_TEMPLATE.md: clarify a few things 2016-02-28 08:50:33 +00:00
Arseniy Seroka ac9ab2c3f5 PULL_REQUEST_TEMPLATE: init 2016-02-22 13:45:56 +03:00