From b62a3692d7ee84a127e9a1388a9c8ca66826eda0 Mon Sep 17 00:00:00 2001 From: Carles Cufi Date: Fri, 10 Jul 2020 17:32:18 +0200 Subject: [PATCH] doc: contribution: Add link to the coding guidelines Add a small section that describes the existance of the coding guidelines page and links to it, in order to raise awareness of the effort towards complying with those. Signed-off-by: Carles Cufi --- doc/contribute/index.rst | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/doc/contribute/index.rst b/doc/contribute/index.rst index 0d98fe156f3..83863a13fc2 100644 --- a/doc/contribute/index.rst +++ b/doc/contribute/index.rst @@ -249,6 +249,13 @@ The `builds@lists.zephyrproject.org mailing list `_ archives the CI (shippable) nightly build results. +Coding Guidelines +***************** + +Beyond the :ref:`coding_style` that Zephyr enforces for all code that is +submitted for inclusion, the project targets compliance with a series of +coding guidelines. Refer to the :ref:`coding_guidelines` section of the +documentation for additional details. .. _Contribution Tools: @@ -337,6 +344,8 @@ On Linux systems, you can install uncrustify with For Windows installation instructions see the `sourceforge listing for uncrustify `_. +.. _coding_style: + Coding Style ************