diff options
| author | Silvan Mosberger <contact@infinisil.com> | 2023-11-14 08:11:41 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-11-14 08:11:41 +0100 |
| commit | e89ad8355524b931cfd02512525d20a6dd73fa5d (patch) | |
| tree | 00e19d25ea8344e76a0baffde62a5183ad0cbfcb /lib | |
| parent | b0eb18fd1d087d371ef1a8d14ee6dd46bdcc9874 (diff) | |
| parent | e93a3d7b586022f900f176cf46e7a3bf211cfaf9 (diff) | |
Merge pull request #263059 from DanielSidhion/add-doc-convention
doc: commit header convention for documentation changes
Diffstat (limited to 'lib')
| -rw-r--r-- | lib/README.md | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/lib/README.md b/lib/README.md index 627086843db7c..220940bc21224 100644 --- a/lib/README.md +++ b/lib/README.md @@ -74,3 +74,23 @@ path/tests/prop.sh # Run the lib.fileset tests fileset/tests.sh ``` + +## 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: + + ``` + lib.(section): (init | add additional argument | refactor | etc) + + (Motivation for change. Additional information.) + ``` + + Examples: + + * lib.getExe': check arguments + * lib.fileset: Add an additional argument in the design docs + + Closes #264537 + |