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

nixos/README.md: relax the requirement of providing option defaults (#334509)

Browse source
This commit is contained in:
Aleksana 2025-01-15 11:10:46 +08:00 • committed by GitHub
commit 0bd024d34e
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
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

@ -84,6 +84,9 @@ Reviewing process:
- Ensure that the introduced options are correct. - 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). - 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. - 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 - Ensure that module `meta` field is present
- Maintainers should be declared in `meta.maintainers`. - Maintainers should be declared in `meta.maintainers`.
- Module documentation should be declared with `meta.doc`. - Module documentation should be declared with `meta.doc`.