From 831368c43d74554e8c1fa2dac0c8d80d6ef587d1 Mon Sep 17 00:00:00 2001 From: Anas Nashif Date: Wed, 15 Jan 2025 17:14:00 -0500 Subject: [PATCH] doc: coding guidelines: move safety relate blurb to saftey section Move some of the historical safety related langugae and enforcement strategy re coding guidelines to the safety section. The coding guidelines are and have been in effect for a while now, but it seems this introduction text is confusing contributors. Signed-off-by: Anas Nashif --- doc/contribute/coding_guidelines/index.rst | 36 ------------------- doc/safety/safety_overview.rst | 40 ++++++++++++++++++++++ 2 files changed, 40 insertions(+), 36 deletions(-) diff --git a/doc/contribute/coding_guidelines/index.rst b/doc/contribute/coding_guidelines/index.rst index 5c5000b3d4b697d..131a7f31b1c1685 100644 --- a/doc/contribute/coding_guidelines/index.rst +++ b/doc/contribute/coding_guidelines/index.rst @@ -3,42 +3,6 @@ Coding Guidelines ################# -The project TSC and the Safety Committee of the project agreed to implement -a staged and incremental approach for complying with a set of coding rules (AKA -Coding Guidelines) to improve quality and consistency of the code base. Below -are the agreed upon stages: - -Stage I (COMPLETED) - Coding guideline rules are available to be followed and referenced, - but not enforced. Rules are not yet enforced in CI and pull-requests cannot be - blocked by reviewers/approvers due to violations. - -Stage II - Begin enforcement on a limited scope of the code base. Initially, this would be - the safety certification scope. For rules easily applied across codebase, we - should not limit compliance to initial scope. This step requires tooling, - CI setup and an enforcement strategy. - -Stage III - Revisit the coding guideline rules and based on experience from previous - stages, refine/iterate on selected rules. - -Stage IV - Expand enforcement to the wider codebase. Exceptions may be granted on some - areas of the codebase with a proper justification. Exception would require - TSC approval. - -.. note:: - - Coding guideline rules may be removed/changed at any time by filing a - GH issue/RFC. - -.. important:: - - **Current stage:** - The prerequisites for entering **Stage II** are currently being looked at: - The tooling is in evaluation, CI setup and `enforcement strategy - `__ is being worked on. Main rules ********** diff --git a/doc/safety/safety_overview.rst b/doc/safety/safety_overview.rst index d3e907f340d66b3..16106582a398372 100644 --- a/doc/safety/safety_overview.rst +++ b/doc/safety/safety_overview.rst @@ -147,6 +147,46 @@ system. Also the **IEC 61508 standard** sets a pre-condition and recommendation towards the use of coding standards / guidelines to reduce likelihood of errors. +The project TSC and the Safety Committee of the project agreed to implement +a staged and incremental approach for complying with a set of coding rules (AKA +Coding Guidelines) to improve quality and consistency of the code base. Below +are the agreed upon stages: + +Stage I (COMPLETED) + Coding guideline rules are available to be followed and referenced, + but not enforced. Rules are not yet enforced in CI and pull-requests cannot be + blocked by reviewers/approvers due to violations. + +Stage II + Reviewers/approvers can block pull-requests due to violations of the coding guidelines + in pull-requests across the codebase. + + Begin enforcement on a limited scope of the code base. Initially, this would be + the safety certification scope. For rules easily applied across codebase, we + should not limit compliance to initial scope. This step requires tooling, + CI setup and an enforcement strategy. + +Stage III + Revisit the coding guideline rules and based on experience from previous + stages, refine/iterate on selected rules. + +Stage IV + Expand enforcement to the wider codebase. Exceptions may be granted on some + areas of the codebase with a proper justification. Exception would require + TSC approval. + +.. note:: + + Coding guideline rules may be removed/changed at any time by filing a + GH issue/RFC. + +.. important:: + + **Current stage:** + The prerequisites to complete **Stage II** are currently being looked at: + The tooling is in evaluation, CI setup and `enforcement strategy + `__ is being worked on. + Requirements and requirements tracing -------------------------------------