Commit graph

127 commits

Author SHA1 Message Date
Maximilian Bosch 19328430aa
CONTRIBUTING: fix anchor to staging-nixos section
Closes #457786
2025-11-04 11:42:08 +01:00
Wolfgang Walther d28cc2a2f5
linux: new workflow for kernel changes (#444973) 2025-10-06 06:41:41 +00:00
Maximilian Bosch 9f95c2ace2
linux: new workflow for kernel changes
See https://github.com/NixOS/nixpkgs/issues/437208#issuecomment-3288623669
Depends on https://github.com/NixOS/org/pull/172

As documented below, the idea is to essentially group all changes
rebuilding all VM tests with kernel updates and merge them together into
`master` whenever the Linux kernels get updated.

This documents the workflow of updates in the nixpkgs manual. While at
it, I removed the README from the packages because

* it's horribly outdated
* I didn't even know it exists which confirms that its discoverability
  was very poor

and added the relevant portions into the nixpkgs manual as well.
2025-10-05 22:59:25 +02:00
Linus Heckemann 1543459f99 CONTRIBUTING: discourage style reviews not based on written rules 2025-09-25 11:30:57 +02:00
Philip Taron 4c30931d69
CONTRIBUTING.md: per discussion, up the number of rebuilds required for mass rebuild to 1000 2025-09-02 14:58:25 -07:00
Philip Taron ab202ef88c
CONTRIBUTING.md: use backticks consistently when referring to a branch name 2025-09-02 12:47:03 -07:00
Wolfgang Walther 0ba05751f9
CONTRIBUTING: default to non-blocking comments
By making blocking comments explicit, it will be easier to discard
certain nits.
2025-08-31 21:33:10 +02:00
Wolfgang Walther 8fa1557784
CONTRIBUTING: clarify pushing to others' PRs is allowed
While squash-merges have been discouraged from already, they become
impossible to do when the Merge Queue is enabled. In certain scenarios
it was tolerated to use these, however, thus we introduce an acceptable
replacement instead.

By making explicit that pushing to contributors PRs is allowed by
default, it should be easier for committers to do so.
2025-08-31 21:33:06 +02:00
Wolfgang Walther 11e679147d
CONTRIBUTING: use pr-template short link
This is explicitly defined below the header, but wasn't used.
2025-08-31 12:34:13 +02:00
Wolfgang Walther 62fe016519
treewide: run treefmt with mdcr/nixfmt 2025-07-24 13:52:31 +02:00
Wolfgang Walther b036b4565f
CONTRIBUTING.md: shorten for readability 2025-07-11 18:20:45 +02:00
Wolfgang Walther 2650a91a2f
CONTRIBUTING.md: remove draft warning
This was added in caef192c81 in 2016. The
issues are not actively being discussed anymore.
2025-06-30 12:31:49 +02:00
Wolfgang Walther b4532efe93
**/README.md: one sentence per line
As documented in doc/README.md.
2025-06-29 21:14:32 +02:00
Tim Schumacher 9b0f8f8186 docs: merge-bot requires authoring by r-ryantm or a committer
This brings the listed conditions into sync between `CONTRIBUTING.md`,
`maintainers/README.md`, and the nixpkgs-merge-bot README.
2025-06-25 06:23:17 +02:00
Markus Wamser f15ca0f2a7
CONTRIBUTING.md: fix link to formt-check workflow 2025-05-17 11:41:11 +02:00
Leona Maroni e56e0beed4
25.11 is Xantusia 2025-05-16 19:21:55 +02:00
Silvan Mosberger 2140bf39e4 CONTRIBUTING: Improve and update formatting docs 2025-04-01 20:09:45 +02:00
Loymdayddaud f6d17c2d87
CONTRIBUTING: fix a small typo 2025-03-08 15:58:25 +03:00
Tristan Ross a0559c7b2b
Release 24.11 2024-11-29 06:28:22 -08:00
Tristan Ross 90fcf3aa7e
25.05 is Warbler 2024-11-14 09:10:54 -08:00
ash 5058251dd8 CONTRIBUTING.md: Add note about nixpkgs-merge-bot restricted authors 2024-11-04 17:11:57 +00:00
Atemu 638402fdde
CONTRIBUTING.md: extend section on getting your PR merged (#350227) 2024-10-24 14:27:52 +02:00
Atemu 9af27c122a
CONTRIBUTING.md: fix broken staging graph in newer mermaid versions (#350258) 2024-10-24 14:26:18 +02:00
Peder Bergebakken Sundt ec3c0f58bc CONTRIBUTING.md: wording nits
I prefer to avoid the phrase "simply" whenever possible
2024-10-24 14:16:31 +02:00
Peder Bergebakken Sundt dcc3d17ef4 CONTRIBUTING.md: extend section on getting your PR merged 2024-10-24 14:16:31 +02:00
aleksana 15d41d4f1d CONTRIBUTING.md: fix broken staging graph in newer mermaid versions 2024-10-22 00:04:23 +08:00
Atemu 8dac8f7bb2 CONTRIBUTING: add practical advice section heading
It was under the "Conventions" heading before which didn't make sense
2024-10-18 07:20:27 +02:00
Atemu 0a0c9e56cd CONTRIBUTING: add section on getting the PR over the finish line 2024-10-17 12:45:04 +02:00
Atemu 9b8aa25e9c CONTRIBUTING: add section on getting your PR merged
This serves as an overview of the process as we currently live it and as a guide
for getting it done quickly and efficiently for people who haven't been
contributing to Nixpkgs for many years.

The intention is to document how the process currently works, set expectations
right, provide recommendations on getting through the process and motivate
people to help us committers help them better. Win-win for everyone.

Co-authored-by: Valentin Gagarin <valentin@fricklerhandwerk.de>
Co-authored-by: Leona Maroni <dev@leona.is>
2024-10-17 12:45:04 +02:00
Silvan Mosberger c2464034c0 CONTRIBUTING: Remove now-unneeded mass ping section
This is not a problem anymore with the parent commit
2024-10-10 01:40:11 +02:00
Artturin 40799fc06d treewide: replace stdenv.is in non nix files
Continuing e0464e4788
2024-09-27 19:07:45 +03:00
Ryan Lahfa 960b838a5f
CONTRIBUTING: offer clearer guidelines about blocker vs. non-blocker issues (#264651)
We sometimes have reviews that are blocked because of miscommunication between author
and reviewer, we make this clear so that reviewers and authors can refer to a block of
"authoritative" text to unblock their own situations.

Co-authored-by: Valentin Gagarin <valentin@gagarin.work>
2024-09-16 13:17:33 +02:00
Dionysis Grigoropoulos 757fe30b63
CONTRIBUTING.md: Update link to committers issue 2024-09-10 12:47:25 +03:00
Silvan Mosberger 8121f5a4bd CONTRIBUTING.md: Mention nixfmt instead of manual formatting rules 2024-07-26 00:37:42 +02:00
Silvan Mosberger ca4a5e1f20 CONTRIBUTING.md: Editorconfig instead of manual description 2024-07-26 00:33:32 +02:00
Emily e820a60e93 CONTRIBUTING.md: point to the Matrix Staging room 2024-07-23 17:30:46 +01:00
Emily 280f31043c CONTRIBUTING.md: allow using PRs to target staging-next 2024-07-23 13:35:06 +01:00
Fritz Otlinghaus 299c0dad47 CONTRIBUTING.md: Add nixpkgs-merge-bot usage paragraph 2024-05-22 19:08:20 +02:00
Weijia Wang 4a817d2083 24.05 is Vicuña 2024-05-22 18:15:34 +02:00
Silvan Mosberger 1daef0114a Remove mentions of documentation-reviewers team
See also https://github.com/NixOS/nix.dev/pull/978
2024-05-13 20:06:16 +02:00
Marcelo Giles 3c009e35d3
contributing: add link to rebasing+squashing
contributing: update link to rebasing+squashing
2024-04-20 20:15:51 -07:00
Janne Heß bc5ee2b8f8 treewide: Switch markdown placeholder from "..." to <...>
We use angle brackets since they look a lot like a placeholder while
also being valid nix code, as suggested by roberth here: https://github.com/NixOS/nixpkgs/pull/299554#discussion_r1541797970
2024-03-28 09:28:12 +01:00
Janne Heß fcc95ff817 treewide: Fix all Nix ASTs in all markdown files
This allows for correct highlighting and maybe future automatic
formatting. The AST was verified to work with nixfmt only.
2024-03-28 09:28:12 +01:00
benaryorg c3b66ce3cc
CONTRIBUTING.md: change table column order for staging
The graph right above the table has the order as `master` ⇒ `staging-next` ⇒ `staging`.
This corresponds with the workflow, i.e. automatic merges happen in that direction and the manual merging is in reverse direction of that.
As a first time reader of this document the table was very confusing due to the disparity of that.
With this change the table should read more fluently for people not familiar with the workflow since the table follows the step-by-step flow of commits.

Signed-off-by: benaryorg <binary@benary.org>
2024-02-23 17:28:16 +00:00
ibbem 6ef8838dcf CONTRIBUTING.md: Sandboxing is enabled by default on Linux
The fact that sandboxing is already enabled by default is mentioned in
the pull request template. Hence, it might be confusing to ask to enable
sandboxing in CONTRIBUTING.md.

Also follow the `one sentence per line` guideline.

Co-authored-by: Silvan Mosberger <github@infinisil.com>
2024-02-12 11:08:47 +01:00
Philipp Riegger da74a75303 doc: fix typo 2024-01-19 12:00:16 +01:00
Valentin Gagarin f1601b35e7 doc: mention new documentation-reviewers subteam 2024-01-15 21:01:21 +01:00
Silvan Mosberger e88fb997e3 CONTRIBUTING.md: Dedent warnings until GitHub fixes it
https://github.com/orgs/community/discussions/16925#discussioncomment-7574895
2023-12-06 04:04:01 +01:00
Silvan Mosberger 4769458228 CONTRIBUTING.md: Update markdown emphasising syntax
GitHub supported special markdown syntax for emphasising blocks for some
time. This was however a beta feature, and still is, so it's subject to
changes.

Recently such a change happened: The syntax is different now.

See https://github.com/orgs/community/discussions/16925 for more
information
2023-12-06 03:51:39 +01:00
figsoda 43a3d2d90e {CONTRIBUTING,PULL_REQUEST_TEMPLATE}.md: update NixOS release 2023-11-27 17:33:01 -05:00