diff options
| author | Peder Bergebakken Sundt <pbsds@hotmail.com> | 2023-10-26 14:06:05 +0200 |
|---|---|---|
| committer | Peder Bergebakken Sundt <pbsds@hotmail.com> | 2023-11-13 13:46:14 +0100 |
| commit | 8feb68f9653d3ed6f371d307b1f740f14f7602a0 (patch) | |
| tree | ee902e18a067342f3db9bbcee099eea595f00da1 /nixos/README.md | |
| parent | cdd3d8500df90882d59264ea6288776dc9b441b7 (diff) | |
{pkgs,nixos}/README.md: Hotlink package and module reviewing guidelines, fix references
Diffstat (limited to 'nixos/README.md')
| -rw-r--r-- | nixos/README.md | 13 |
1 files changed, 8 insertions, 5 deletions
diff --git a/nixos/README.md b/nixos/README.md index b3cd9d234fa61..d0257e12d9333 100644 --- a/nixos/README.md +++ b/nixos/README.md @@ -21,12 +21,14 @@ Reviewing process: - Ensure that the module maintainers are notified. - [CODEOWNERS](https://help.github.com/articles/about-codeowners/) will make GitHub notify users based on the submitted changes, but it can happen that it misses some of the package maintainers. - Ensure that the module tests, if any, are succeeding. + - You may invoke OfBorg with `@ofborg test <module>` to build `nixosTests.<module>` - 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. - Ensure that option changes are backward compatible. - - `mkRenamedOptionModuleWith` provides a way to make option changes backward compatible. -- Ensure that removed options are declared with `mkRemovedOptionModule` + - `mkRenamedOptionModuleWith` provides a way to make renamed option backward compatible. + - Use `lib.versionAtLeast config.system.stateVersion "23.11"` on backward incompatible changes which may corrupt, change or update the state stored on existing setups. +- Ensure that removed options are declared with `mkRemovedOptionModule`. - Ensure that changes that are not backward compatible are mentioned in release notes. - Ensure that documentations affected by the change is updated. @@ -55,6 +57,7 @@ New modules submissions introduce a new module to NixOS. Reviewing process: +- Ensure that all file paths [fit the guidelines](../CONTRIBUTING.md#file-naming-and-organisation). - Ensure that the module tests, if any, are succeeding. - 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). @@ -76,9 +79,9 @@ Sample template for a new module review is provided below. - [ ] options have default - [ ] options have example - [ ] options have descriptions -- [ ] No unneeded package is added to environment.systemPackages -- [ ] meta.maintainers is set -- [ ] module documentation is declared in meta.doc +- [ ] No unneeded package is added to `environment.systemPackages` +- [ ] `meta.maintainers` is set +- [ ] module documentation is declared in `meta.doc` ##### Possible improvements |