Thanks for taking the time to contribute to kmod!
-If you want to submit changes, you can submit GitHub [pull requests] as well as
+If you want to submit changes, you can send 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].
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
+When in doubt, or need a refresher, checking through the output of `git log` is
highly recommended.
## Using commit trailers
### Discussions, references
-If your commit covers a topic raised in an issue, but no the issue itself, or
-otherwise refers to a more complicated topic, you can use `Reference:`
+If your commit covers a topic raised in an issue, but does not resolve the issue
+itself; or otherwise refers to a more complicated topic, you can use
+`Reference:`.
### Bugfixes, regressions
the in-tree [CODING-STYLE file](CODING-STYLE) for quick references.
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
+style. Make sure you run `git-clang-format` against your changes, before
submitting PRs/patches.
## 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].
+If you're unfamiliar with `gtk-doc` here is a [quick primer].
## Tools manual pages
## 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
+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
greatly appreciated.
[pull requests]: https://github.com/kmod-project/kmod/pull/
[GitHub tracker]: https://github.com/kmod-project/kmod/issues/
[linear, "recipe" style]: https://www.bitsnbites.eu/git-history-work-log-vs-recipe/
[gtk-doc]: https://gitlab.gnome.org/GNOME/gtk-doc
-[quick primer]:https://gi.readthedocs.io/en/latest/annotations/gtkdoc.html
+[quick primer]: https://gi.readthedocs.io/en/latest/annotations/gtkdoc.html
[scdoc]: https://sr.ht/~sircmpwn/scdoc/
[markdown-like syntax]: https://man.archlinux.org/man/scdoc.5.en