Skip to content

Commit

Permalink
CONTRIBUTING.md: suggest "nixos/<module>" prefix for NixOS changes
Browse files Browse the repository at this point in the history
Suggest prefixing commit messages that touches NixOS code with
"nixos/<module>" instead of the current "<name> service" prefix.

"<name> service" is limiting in that NixOS code is more than the
services. It is also easier to spot NixOS changes with explicit
"nixos/..." prefix.
  • Loading branch information
bjornfor committed Jul 21, 2017
1 parent 75290ad commit 8537cf0
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ under the terms of [COPYING](../COPYING), which is an MIT-like license.
* Format the commits in the following way:

```
(pkg-name | service-name): (from -> to | init at version | refactor | etc)
(pkg-name | nixos/<module>): (from -> to | init at version | refactor | etc)
(Motivation for change. Additional information.)
```
Expand All @@ -24,10 +24,10 @@ under the terms of [COPYING](../COPYING), which is an MIT-like license.

* nginx: init at 2.0.1
* firefox: 3.0 -> 3.1.1
* hydra service: add bazBaz option
* nixos/hydra: add bazBaz option

Dual baz behavior is needed to do foo.
* nginx service: refactor config generation
* nixos/nginx: refactor config generation

The old config generation system used impure shell scripts and could break in specific circumstances (see #1234).

Expand Down

0 comments on commit 8537cf0

Please sign in to comment.