From abc82de435eebfda2ce86cb3c6b2f05d5ef65063 Mon Sep 17 00:00:00 2001 From: NAHO <90870942+trueNAHO@users.noreply.github.com> Date: Mon, 6 Oct 2025 10:36:32 +0200 Subject: [PATCH] CONTRIBUTING: establish builtins prefix convention for prelude Establish the builtins prefix convention for prelude attributes to progress [1] ("Unwritten style guides should be written"), following the treewide removal of the builtins prefix for prelude attributes [2] [3] [4] [5] [6]. [1]: https://github.com/NixOS/nixpkgs/issues/387072 [2]: https://github.com/NixOS/nixpkgs/pull/444432 [3]: https://github.com/NixOS/nixpkgs/pull/447401 [4]: https://github.com/NixOS/nixpkgs/pull/447402 [5]: https://github.com/NixOS/nixpkgs/pull/447403 [6]: https://github.com/NixOS/nixpkgs/pull/447404 --- CONTRIBUTING.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a1426bb2a0149..3c8b46a7d3ba5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -661,6 +661,15 @@ If you have any problems with formatting, please ping the [formatting team](http As an exception, an explicit conditional expression with null can be used when fixing a important bug without triggering a mass rebuild. If this is done a follow up pull request _should_ be created to change the code to `lib.optional(s)`. +- Certain [prelude + attributes](https://nix.dev/manual/nix/latest/language/builtins.html) should + explicitly use the `builtins` prefix, while others should conveniently omit + it: + + | Use `builtins` | Omit `builtins` | + |----------------|-----------------| + |
  • `builtins.abort`
  • `builtins.baseNameOf`
  • `builtins.break`
  • `builtins.derivation`
  • `builtins.derivationStrict`
  • `builtins.dirOf`
  • `builtins.false`
  • `builtins.fetchGit`
  • `builtins.fetchMercurial`
  • `builtins.fetchTarball`
  • `builtins.fetchTree`
  • `builtins.fromTOML`
  • `builtins.import`
  • `builtins.isNull`
  • `builtins.map`
  • `builtins.null`
  • `builtins.placeholder`
  • `builtins.removeAttrs`
  • `builtins.scopedImport`
  • `builtins.throw`
  • `builtins.toString`
  • `builtins.true`
    • |
  • `abort`
  • `baseNameOf`
  • `break`
  • `derivation`
  • `derivationStrict`
  • `dirOf`
  • `false`
  • `fetchGit`
  • `fetchMercurial`
  • `fetchTarball`
  • `fetchTree`
  • `fromTOML`
  • `import`
  • `isNull`
  • `map`
  • `null`
  • `placeholder`
  • `removeAttrs`
  • `scopedImport`
  • `throw`
  • `toString`
  • `true`
    • | + - Any style choices not covered here but that can be expressed as general rules should be left at the discretion of the authors of changes and _not_ commented in reviews. The purpose of this is: - to avoid churn as contributors with different style preferences undo each other's changes,