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.
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.
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