]> git.ipfire.org Git - thirdparty/kmod.git/commitdiff
CONTRIBUTING.md: tweaks the section names a bit
authorEmil Velikov <emil.l.velikov@gmail.com>
Mon, 16 Sep 2024 10:04:36 +0000 (11:04 +0100)
committerLucas De Marchi <lucas.de.marchi@gmail.com>
Tue, 17 Sep 2024 02:49:47 +0000 (21:49 -0500)
Make them a little less terse and natural.

v2:
 - tag -> trailer

Signed-off-by: Emil Velikov <emil.l.velikov@gmail.com>
Link: https://github.com/kmod-project/kmod/pull/134
Signed-off-by: Lucas De Marchi <lucas.de.marchi@gmail.com>
CONTRIBUTING.md

index 627e7d746c6fd0b1649778cd324239490427d72c..93677f2c6cf2dc96d6f6197a92825bb82c43354e 100644 (file)
@@ -6,7 +6,7 @@ If you want to submit changes, you can submit GitHub [pull requests] as well as
 patches sent to the [mailing list]. In addition you can open issues and feature
 requests on our [GitHub tracker].
 
-## Commits
+## Commit style and history
 
 The kmod project uses a [linear, "recipe" style] history. This means that
 commits should be small, digestible, stand-alone, and functional.
@@ -16,7 +16,7 @@ Commit messages are in imperative mood and merges are to be avoided.
 When in doubt, or need a regresher, checking through the output of `git log` is
 highly recommended.
 
-## Commit tailers
+## Using commit trailers
 
 Commit messages, apart from stating why a particular change is made, can include
 a range of trailers.
@@ -49,19 +49,19 @@ We also have a [.clang-format file](.clang-format) to ease and enforce the
 style. Make sure you run git-clang-format against your changes, before
 submitting PRs/patches.
 
-## Documentation
+## API documentation
 
 The official libkmod documentation is generated by [gtk-doc] and a simple test
 is wired to `meson test` to catch accidental mistakes or omissions.
 
 If you're unfamiliar with gtk-doc here is a [quick primer].
 
-## Manual pages
+## Tools manual pages
 
 Our manual pages are written in [scdoc] a simple [markdown-like syntax]. Please
 make sure to update them as you add new options to the kmod tools.
 
-## Shell completions
+## Tools shell completion
 
 The project aims to provide bash, zsh and fish shell completions for all the
 kmod tools. Currently support is borderline non-existent, so your help is