NixOS: Module Review Processes (Updates and New Modules)

Reviewing process: - Ensure that the module maintainers are notified. - The continuous integration system 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 renamed option backward compatible. - Use `lib.versionAtLeast config.system.stateVersion "24.05"` 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. Sample template for a module update review is provided below. ```markdown ##### Reviewed points - [ ] changes are backward compatible - [ ] removed options are declared with `mkRemovedOptionModule` - [ ] changes that are not backward compatible are documented in release notes - [ ] module tests succeed on ARCHITECTURE - [ ] options types are appropriate - [ ] options description is set - [ ] options example is provided - [ ] documentation affected by the changes is updated ##### Possible improvements ##### Comments ``` ### New modules 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 new module tests are added to the package `passthru.tests`. - 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`. - Ensure that the module respect other modules functionality. - For example, enabling a module should not open firewall ports by default. Sample template for a new module review is provided below. ```markdown ##### Reviewed points - [ ] module path fits the guidelines - [ ] module tests, if any, succeed on ARCHITECTURE - [ ] module tests, if any, are added to package `passthru.tests` - [ ] options have appropriate types - [ ] 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` ##### Possible improvements ##### Comments ```

This section outlines the review processes for NixOS module updates and new modules. For module updates, reviewers must ensure maintainers are notified, tests pass, options are correct (type, description, default, example), changes are backward compatible (using `mkRenamedOptionModuleWith` and version checks), removed options are declared, release notes cover non-backward-compatible changes, and documentation is updated. A review template is provided. For new modules, reviewers check file paths, test success, inclusion of tests in `passthru.tests`, option correctness, presence of module `meta` fields (maintainers, documentation), and respect for other modules' functionality. A separate review template is provided for new modules.