From e93a3d7b586022f900f176cf46e7a3bf211cfaf9 Mon Sep 17 00:00:00 2001 From: DS Date: Mon, 23 Oct 2023 19:51:50 -0700 Subject: doc: separate commit header conventions for each area, info on docs changes. --- lib/README.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) (limited to 'lib/README.md') diff --git a/lib/README.md b/lib/README.md index 627086843db..220940bc212 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 + -- cgit 1.4.1