doc/readme: align with new commit convention

This commit is contained in:
Johannes Kirschbauer
2026-07-16 19:25:59 +02:00
parent e1a41bb89e
commit 404c544b1f
+3 -3
View File
@@ -198,15 +198,15 @@ watermelon
- If creating a commit purely for documentation changes, format the commit message in the following way:
```
doc: (documentation summary)
doc/component: (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`
* doc/stdenv: update the kernel config documentation to use `nix-shell`
* doc/getting-started: add information about `nix-update-script`
Closes #216321.