diff options
author | DS <commits@sidhion.com> | 2023-10-23 19:51:50 -0700 |
---|---|---|
committer | DS <commits@sidhion.com> | 2023-11-13 20:41:08 -0800 |
commit | e93a3d7b586022f900f176cf46e7a3bf211cfaf9 (patch) | |
tree | 041f030beff32d18bc1bda52f0a60add1bf747d4 /nixos/README.md | |
parent | 30c67fb5a635e0f53d03dd3825b0f11e8afd4b7d (diff) | |
download | nixpkgs-e93a3d7b586022f900f176cf46e7a3bf211cfaf9.tar nixpkgs-e93a3d7b586022f900f176cf46e7a3bf211cfaf9.tar.gz nixpkgs-e93a3d7b586022f900f176cf46e7a3bf211cfaf9.tar.bz2 nixpkgs-e93a3d7b586022f900f176cf46e7a3bf211cfaf9.tar.lz nixpkgs-e93a3d7b586022f900f176cf46e7a3bf211cfaf9.tar.xz nixpkgs-e93a3d7b586022f900f176cf46e7a3bf211cfaf9.tar.zst nixpkgs-e93a3d7b586022f900f176cf46e7a3bf211cfaf9.zip |
doc: separate commit header conventions for each area, info on docs changes.
Diffstat (limited to 'nixos/README.md')
-rw-r--r-- | nixos/README.md | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/nixos/README.md b/nixos/README.md index b3cd9d234fa..7f258eb393a 100644 --- a/nixos/README.md +++ b/nixos/README.md @@ -8,6 +8,27 @@ https://nixos.org/nixos and in the manual in doc/manual. You can add new module to your NixOS configuration file (usually it’s `/etc/nixos/configuration.nix`). And do `sudo nixos-rebuild test -I nixpkgs=<path to your local nixpkgs folder> --fast`. +## Commit conventions + +- Make sure you read about the [commit conventions](../CONTRIBUTING.md#commit-conventions) common to Nixpkgs as a whole. + +- Format the commit messages in the following way: + + ``` + nixos/(module): (init module | add setting | refactor | etc) + + (Motivation for change. Link to release notes. Additional information.) + ``` + + Examples: + + * nixos/hydra: add bazBaz option + + Dual baz behavior is needed to do foo. + * nixos/nginx: refactor config generation + + The old config generation system used impure shell scripts and could break in specific circumstances (see #1234). + ## Reviewing contributions When changing the bootloader installation process, extra care must be taken. Grub installations cannot be rolled back, hence changes may break people’s installations forever. For any non-trivial change to the bootloader please file a PR asking for review, especially from \@edolstra. |