Skip to content

CONTRIBUTING: Add guideline to document motivation for special packaging choices#416728

Merged
wolfgangwalther merged 1 commit intoNixOS:masterfrom
pbsds:doc-comment-on-package-pins-1749916266
Jun 27, 2025
Merged

CONTRIBUTING: Add guideline to document motivation for special packaging choices#416728
wolfgangwalther merged 1 commit intoNixOS:masterfrom
pbsds:doc-comment-on-package-pins-1749916266

Conversation

@pbsds
Copy link
Member

@pbsds pbsds commented Jun 14, 2025

This helps with retaining domain knowledge, sorely needed during treewide fixups and bumps.

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/)
  • Nixpkgs 25.11 Release Notes (or backporting 24.11 and 25.05 Nixpkgs Release notes)
    • (Package updates) Added a release notes entry if the change is major or breaking
  • NixOS 25.11 Release Notes (or backporting 24.11 and 25.05 NixOS Release notes)
    • (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, pkgs/README.md, maintainers/README.md and other contributing documentation in corresponding paths.

Add a 👍 reaction to pull requests you find important.

@pbsds pbsds mentioned this pull request Jun 14, 2025
13 tasks
@nix-owners nix-owners bot requested a review from infinisil June 14, 2025 16:03
@pbsds pbsds added the 9.needs: community feedback This needs feedback from more community members. label Jun 14, 2025
@Aleksanaa
Copy link
Member

I made this days ago: #416157

@github-actions github-actions 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. 6.topic: policy discussion Discuss policies to work in and around Nixpkgs labels Jun 14, 2025
@pbsds
Copy link
Member Author

pbsds commented Jun 14, 2025

Hey neat! These are not mutually exclusive however, and repetition legitimizes 👍

@pbsds pbsds force-pushed the doc-comment-on-package-pins-1749916266 branch from 810560e to 612a69d Compare June 14, 2025 16:20
@pbsds pbsds force-pushed the doc-comment-on-package-pins-1749916266 branch from 612a69d to e393725 Compare June 14, 2025 16:27
@pbsds pbsds force-pushed the doc-comment-on-package-pins-1749916266 branch from e393725 to 00caa90 Compare June 14, 2025 16:52
…ing choices

This helps with retaining domain knowledge, sorely needed during treewide fixups and bumps.
@pbsds pbsds force-pushed the doc-comment-on-package-pins-1749916266 branch from 00caa90 to 0930b56 Compare June 18, 2025 23:58
@github-actions github-actions bot added the 12.approvals: 1 This PR was reviewed and approved by one person. label Jun 19, 2025
@wolfgangwalther
Copy link
Contributor

I'd say let's do this, because nobody objected to it (and I don't see a reason to do so, really).

@wolfgangwalther wolfgangwalther merged commit 784eeb7 into NixOS:master Jun 27, 2025
25 of 26 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

6.topic: policy discussion Discuss policies to work in and around Nixpkgs 9.needs: community feedback This needs feedback from more community members. 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. 12.approvals: 1 This PR was reviewed and approved by one person.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants