summary refs log tree commit diff
path: root/.github/CONTRIBUTING.md
diff options
context:
space:
mode:
authorBjørn Forsman <bjorn.forsman@gmail.com>2017-07-15 16:32:01 +0200
committerBjørn Forsman <bjorn.forsman@gmail.com>2017-07-22 00:21:05 +0200
commit8537cf0f818a95073e93ac755e9fa17c30982caa (patch)
treea3577a93b5fd5e84d307dafcd53af38ad175d7e1 /.github/CONTRIBUTING.md
parent75290adaa91a75cea789ff1b849c005bc23412f3 (diff)
downloadnixpkgs-8537cf0f818a95073e93ac755e9fa17c30982caa.tar
nixpkgs-8537cf0f818a95073e93ac755e9fa17c30982caa.tar.gz
nixpkgs-8537cf0f818a95073e93ac755e9fa17c30982caa.tar.bz2
nixpkgs-8537cf0f818a95073e93ac755e9fa17c30982caa.tar.lz
nixpkgs-8537cf0f818a95073e93ac755e9fa17c30982caa.tar.xz
nixpkgs-8537cf0f818a95073e93ac755e9fa17c30982caa.tar.zst
nixpkgs-8537cf0f818a95073e93ac755e9fa17c30982caa.zip
CONTRIBUTING.md: suggest "nixos/<module>" prefix for NixOS changes
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.
Diffstat (limited to '.github/CONTRIBUTING.md')
-rw-r--r--.github/CONTRIBUTING.md6
1 files changed, 3 insertions, 3 deletions
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
index 14f60b936f8..b77ca7eefb9 100644
--- a/.github/CONTRIBUTING.md
+++ b/.github/CONTRIBUTING.md
@@ -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.)
   ```
@@ -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).