From 72400b2c2916e52ab6e5da26cb2e5ac9e15470a7 Mon Sep 17 00:00:00 2001 From: Robert Helgesson Date: Mon, 6 Jan 2020 11:25:09 +0100 Subject: [PATCH] contributing.md: minor update This elaborates the instructions for the news entry of new modules. (cherry picked from commit ef6674d1d1550bbe151f8570c974beb5eba88f24) --- CONTRIBUTING.md | 13 ++++++++----- 1 file changed, 8 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 156d0c9da..d441aef06 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -139,15 +139,18 @@ If you do have a change worthy of a news entry then please add one in > use 'services.myservice.bar' instead. - A new module, say `foo.nix`, should always include a news entry - (without any condition) that has a message along the lines of + that has a message along the lines of - > A new service is available: 'services.foo'. + > A new module is available: 'services.foo'. - or + If the module is platform specific, e.g., a service module using + systemd, then a condition like - > A new program configuration is available: 'program.foo'. + ``` + condition = hostPlatform.isLinux; + ``` - depending on the type of module. + should be added. [open issues]: https://github.com/rycee/home-manager/issues [new issue]: https://github.com/rycee/home-manager/issues/new