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>
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>
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>
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>
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
Particularities about style should be enforced at the tooling level (linters,
code beautifiers etc.). Otherwise, it adds more weight on the PR reviewing,
distracting both authors and reviewers from the substance of the changes.
- Fix sentence about meeting contributing standards
- pkgs -> packages
- Use emoji's because GitHub renders the :*: things weird sometimes
- Move a dot
Co-authored-by: Rémi NICOLE <minijackson@users.noreply.github.com>
- Contributing without a GitHub account
- Mention OfBorg
- nix.useSandbox -> nix.settings.sandbox
- nixpkgs-review is good for not just version updates
Co-authored-by: Rémi NICOLE <minijackson@users.noreply.github.com>
