Skip to content

Commit

Permalink
doc: coding guidelines: move safety relate blurb to saftey section
Browse files Browse the repository at this point in the history
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 <[email protected]>
  • Loading branch information
nashif committed Jan 15, 2025
1 parent 4b06ace commit 831368c
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 36 deletions.
36 changes: 0 additions & 36 deletions doc/contribute/coding_guidelines/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
<https://github.com/zephyrproject-rtos/zephyr/issues/58903>`__ is being worked on.

Main rules
**********
Expand Down
40 changes: 40 additions & 0 deletions doc/safety/safety_overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
<https://github.com/zephyrproject-rtos/zephyr/issues/58903>`__ is being worked on.

Requirements and requirements tracing
-------------------------------------

Expand Down

0 comments on commit 831368c

Please sign in to comment.