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 /doc | |
| 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 'doc')
| -rw-r--r-- | doc/README.md | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/doc/README.md b/doc/README.md index 3f9aff1a38a..9dee2d30d73 100644 --- a/doc/README.md +++ b/doc/README.md @@ -114,3 +114,24 @@ pear watermelon : green fruit with red flesh ``` + +## Commit conventions + +- Make sure you read about the [commit conventions](../CONTRIBUTING.md#commit-conventions) common to Nixpkgs as a whole. + +- If creating a commit purely for documentation changes, format the commit message in the following way: + + ``` + doc: (documentation summary) + + (Motivation for change, relevant links, additional information.) + ``` + + Examples: + + * doc: update the kernel config documentation to use `nix-shell` + * doc: add information about `nix-update-script` + + Closes #216321. + +- If the commit contains more than just documentation changes, follow the commit message format relevant for the rest of the changes. |