From: Emil Velikov Date: Wed, 28 Jan 2026 19:17:07 +0000 (+0000) Subject: CONTRIBUTING.md: less "you", use calmer style X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=b3f550c843fc1385b5154aa14072069576d0e2b1;p=thirdparty%2Fkmod.git CONTRIBUTING.md: less "you", use calmer style While initially writing this file, I didn't quite realise how much it was trying to reach out and point back at the reader. Signed-off-by: Emil Velikov Reviewed-by: Lucas De Marchi Link: https://github.com/kmod-project/kmod/pull/pull/417 Signed-off-by: Lucas De Marchi --- diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7667055d..1e0e5179 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,9 +2,9 @@ Thanks for taking the time to contribute to kmod! -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]. +To submit changes, open a GitHub [pull requests] or send patches to the +[mailing list]. In addition, issues and feature requests can be opened on our +[GitHub tracker]. In this file you can find: @@ -46,7 +46,7 @@ a range of trailers. ### Signed-off-by -By using a `Signed-off-by:` trailer you agree that you comply with the +By using a `Signed-off-by:` trailer the author agrees that they comply with the Developer Certificate of Origin v1.1, as seen below: Developer Certificate of Origin @@ -93,9 +93,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 does not resolve the issue -itself; or otherwise refers to a more complicated topic, you can use -`Reference:`. +If the commit covers a topic raised in an issue, but does not resolve the issue +itself; or otherwise refers to a more complicated topic, use of `Reference:` is +recommended. ### Link(s) @@ -117,16 +117,17 @@ commit addresses an issue caused by another commit, use `Fixes:` as below: 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 -submitting PRs/patches. +To ease and enforce the style a [.clang-format file](.clang-format) file is +provided and ran in CI against all submissions. + +Make sure to run `git-clang-format` 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]. +Here is a [quick primer] to get up-to speed with `gtk-doc`. When adding new API, make sure to include the `Since:` token and add a new api-index section in `libkmod/docs/libkmod-docs.xml`. @@ -134,7 +135,7 @@ api-index section in `libkmod/docs/libkmod-docs.xml`. ## 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. +make sure to update them as options get added, removed or changed. ## Tools shell completion