Skip to content

CONTRIBUTING: offer clearer guidelines about blocker vs. non-blocker issues#264651

Merged
fricklerhandwerk merged 2 commits intoNixOS:masterfrom
RaitoBezarius:contributing-nits
Sep 16, 2024
Merged

CONTRIBUTING: offer clearer guidelines about blocker vs. non-blocker issues#264651
fricklerhandwerk merged 2 commits intoNixOS:masterfrom
RaitoBezarius:contributing-nits

Conversation

@RaitoBezarius
Copy link
Member

Description of changes

Brought by https://matrix.to/#/!kjdutkOsheZdjqYmqp:nixos.org/$IuFJ-rB798l9jYfcWm9RyYfD5EDb420xc0kwa-FgZZo?via=nixos.org&via=matrix.org&via=nixos.dev discussion.

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.

Things done

  • Built on platform(s)
    • x86_64-linux
    • aarch64-linux
    • x86_64-darwin
    • aarch64-darwin
  • For non-Linux: Is sandboxing enabled in nix.conf? (See Nix manual)
    • sandbox = relaxed
    • sandbox = true
  • Tested, as applicable:
  • Tested compilation of all packages that depend on this change using nix-shell -p nixpkgs-review --run "nixpkgs-review rev HEAD". Note: all changes have to be committed, also see nixpkgs-review usage
  • Tested basic functionality of all binary files (usually in ./result/bin/)
  • 23.11 Release Notes (or backporting 23.05 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.

…issues in a PR

Brought by https://matrix.to/#/!kjdutkOsheZdjqYmqp:nixos.org/$IuFJ-rB798l9jYfcWm9RyYfD5EDb420xc0kwa-FgZZo?via=nixos.org&via=matrix.org&via=nixos.dev
discussion.

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.
@RaitoBezarius RaitoBezarius marked this pull request as draft October 31, 2023 18:58
Copy link
Member

@infinisil infinisil left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This section is quite large already, would be nice to have this new part (or all of its parts really) in sub sections. This way they can also be linked to.

@kirillrdy
Copy link
Member

don't want to increase the scope of this PR, but how about something like https://conventionalcomments.org/ ? so that suggestions during review are very obviously different from requests

@ofborg ofborg bot added 10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin. 10.rebuild-linux: 0 This PR does not cause any packages to rebuild on Linux. labels Oct 31, 2023
@RaitoBezarius
Copy link
Member Author

don't want to increase the scope of this PR, but how about something like conventionalcomments.org ? so that suggestions during review are very obviously different from requests

I'm okay with mentioning as an example.

@fricklerhandwerk fricklerhandwerk marked this pull request as ready for review June 4, 2024 07:49
@fricklerhandwerk fricklerhandwerk self-assigned this Jun 4, 2024
@fricklerhandwerk fricklerhandwerk dismissed infinisil’s stale review September 16, 2024 11:16

I think that's okay for now

@fricklerhandwerk fricklerhandwerk merged commit 960b838 into NixOS:master Sep 16, 2024
@Atemu Atemu mentioned this pull request Sep 16, 2024
13 tasks
@emilazy emilazy mentioned this pull request Feb 10, 2025
13 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

10.rebuild-darwin: 0 This PR does not cause any packages to rebuild on Darwin. 10.rebuild-linux: 0 This PR does not cause any packages to rebuild on Linux.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants