movefasta/nixpkgs
1
0
Fork 0
mirror of https://github.com/NixOS/nixpkgs.git synced 2025-06-09 19:13:26 +03:00
Code Issues Projects Releases Packages Wiki Activity

nixos/README.md: relax the requirement of providing option defaults

Browse source 
If we enforce the requirement of option defaults to the extreme, then we end up with silly sentinel values, a bunch of nullable types, and assertions checking for sentinel values.
This commit is contained in:
Peder Bergebakken Sundt 2024-08-14 03:49:23 +02:00
parent 5f6606b3a8
commit 959155e56a
1 changed files with 3 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

3
nixos/README.md
View file

@ -83,6 +83,9 @@ Reviewing process:
- Ensure that the introduced options are correct.
- Type should be appropriate (string related types differs in their merging capabilities, `loaOf` and `string` types are deprecated).
- Description, default and example should be provided.
- Defaults may only be omitted if both:
1. The user is required to set the default in order to properly use the service.
2. The lack of a default does not break evaluation when the module is not enabled.
- Ensure that module `meta` field is present
- Maintainers should be declared in `meta.maintainers`.
- Module documentation should be declared with `meta.doc`.