michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: guidelines: update coding guidelines docs

Browse source 
Remove references to a timline for the coding guidelines enforcement
stages. Mark the current stage better and add notes about the
current stage.

Signed-off-by: Simon Hein <Shein@baumer.com>
This commit is contained in:
Simon Hein 2024-06-28 16:34:01 +02:00 • committed by Anas Nashif
commit a5668c78d1
1 changed files with 9 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

11
doc/contribute/coding_guidelines/index.rst
View file

@ -6,9 +6,9 @@ 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 and the approximate timelines:
are the agreed upon stages:
Stage I
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.
@ -33,6 +33,13 @@ Stage IV
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
**********