From e1a8992b547b64950fbb55dedb37042b16585f70 Mon Sep 17 00:00:00 2001 From: Emil Velikov Date: Mon, 16 Sep 2024 11:35:47 +0100 Subject: [PATCH] CONTRIBUTING.md: add inline TOC 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 Link: https://github.com/kmod-project/kmod/pull/134 Signed-off-by: Lucas De Marchi --- CONTRIBUTING.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ad4a690d..8648eba4 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 -- 2.47.3