]> git.ipfire.org Git - thirdparty/kmod.git/commitdiff
CONTRIBUTING.md: add inline TOC
authorEmil Velikov <emil.l.velikov@gmail.com>
Mon, 16 Sep 2024 10:35:47 +0000 (11:35 +0100)
committerLucas De Marchi <lucas.de.marchi@gmail.com>
Tue, 17 Sep 2024 02:49:47 +0000 (21:49 -0500)
While the file is small, it does cover a handful of topics. So include a
simple TOC and the start to make browsing a little bit easier.

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 ad4a690d9b827c2b177e5d200ec1e60de125aef8..8648eba4772b071f316f04a709d8fdbc26bd2c70 100644 (file)
@@ -6,6 +6,19 @@ 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].
 
+In this file you can find:
+  * [Commit style and history](#commit-style-and-history)
+  * [Using commit trailers](#using-commit-trailers)
+    + [Signed-off-by](#signed-off-by)
+    + [Issues, feature requests](#issues--feature-requests)
+    + [Discussions, references](#discussions--references)
+    + [Link(s)](#link-s-)
+    + [Bugfixes, regressions](#bugfixes--regressions)
+  * [Coding style](#coding-style)
+  * [API documentation](#api-documentation)
+  * [Tools manual pages](#tools-manual-pages)
+  * [Tools shell completion](#tools-shell-completion)
+
 ## Commit style and history
 
 The kmod project uses a [linear, "recipe" style] history. This means that