From: Emil Velikov Date: Mon, 16 Sep 2024 10:05:28 +0000 (+0100) Subject: CONTRIBUTING.md: small grammar/typo/style fixes X-Git-Tag: v34~351 X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=bd97fe06f76890e2ee22ae4ce6a8d529be1aecc1;p=thirdparty%2Fkmod.git CONTRIBUTING.md: small grammar/typo/style fixes v2 - drop erroneous "a" Signed-off-by: Emil Velikov Link: https://github.com/kmod-project/kmod/pull/134 Signed-off-by: Lucas De Marchi --- diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 93677f2c..b4da504b 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,7 +2,7 @@ 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]. @@ -13,7 +13,7 @@ commits should be small, digestible, stand-alone, and functional. 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 @@ -30,8 +30,9 @@ tracker] or elsewhere, use the `Closes:` trailer followed by the full URL. ### 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 @@ -46,7 +47,7 @@ The project uses style practically identical to the kernel style. You can see 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 @@ -54,7 +55,7 @@ submitting PRs/patches. 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 @@ -63,8 +64,8 @@ make sure to update them as you add new options to the kmod tools. ## 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/ @@ -72,6 +73,6 @@ greatly appreciated. [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