Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

CONTRIBUTING.md: patch conventions #317314

Merged
merged 1 commit into from
Jun 9, 2024

Conversation

raboof
Copy link
Member

@raboof raboof commented Jun 4, 2024

Description of changes

As discussed in the NixOS Security Discussion Matrix room at https://matrix.to/#/!NBBFPbiuttRgTqbrcY:nixos.org/$kRB7R9ksae-78H4GQOO7NjMurKh7hSHimYSGMVE3w8k?via=nixos.org&via=matrix.org&via=nixos.dev and #317169

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/)
  • 24.11 Release Notes (or backporting 23.11 and 24.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.

Add a 👍 reaction to pull requests you find important.

@raboof raboof requested a review from infinisil as a code owner June 4, 2024 22:58
@raboof raboof mentioned this pull request Jun 4, 2024
13 tasks
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 should go here instead

Copy link
Contributor

@drupol drupol left a comment

Choose a reason for hiding this comment

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

LGTM. I made an attempt a while ago at #246766 but somehow got distracted by some other things and forgot about it.

pkgs/README.md Outdated Show resolved Hide resolved
Patches available online should be retrieved using `fetchpatch`.
Sometimes, changes are needed to the source to allow building a derivation in nixpkgs, or to get earlier access to an upstream fix or improvement. When using the `patches` parameter to `mkDerivation`, make sure the patch name clearly describes the reason for the patch, or add a comment.

Patches already merged upstream or published elsewhere should be retrieved using `fetchpatch`.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Patches already merged upstream or published elsewhere should be retrieved using `fetchpatch`.
Patches already merged upstream, reviewed or published elsewhere should be retrieved using `fetchpatch`.

Copy link
Member Author

@raboof raboof Jun 5, 2024

Choose a reason for hiding this comment

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

Thanks for your suggestions! I have merged the others but not this one, as I don't think it makes sense to fetchpatch patches that have been reviewed but not merged: they might still get rebased/squashed and thus disappear.

pkgs/README.md Outdated Show resolved Hide resolved
@raboof raboof force-pushed the contributing-patch-conventions branch from 7e64be9 to cbfd7ee Compare June 5, 2024 21:04
@raboof raboof mentioned this pull request Jun 9, 2024
13 tasks
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.

Looking good! Let's just merge, we can make incremental improvements in future PRs if necessary :)

@infinisil infinisil merged commit d03f9e2 into NixOS:master Jun 9, 2024
19 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants