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 /lib/README.md | |
| parent | 30c67fb5a635e0f53d03dd3825b0f11e8afd4b7d (diff) | |
doc: separate commit header conventions for each area, info on docs changes.
Diffstat (limited to 'lib/README.md')
| -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 627086843db7..220940bc2122 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 + |