adafruit-mirror/zephyr
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 9

doc: review: switch labels to a definition list

Browse source 
Move labels docs from headers to a definition list.

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
This commit is contained in:
Anas Nashif 2025-01-20 09:28:54 -05:00 committed by Benjamin Cabé
parent 22b1e70b08
commit 7ae2b5033e
1 changed files with 29 additions and 39 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

68
doc/project/dev_env_and_tools.rst
View file

@ -65,55 +65,45 @@ Categories/Labels
----------------- -----------------
Hotfix Hotfix
++++++ Any change that is a fix to an issue that blocks developers from doing their
daily work, for example CI breakage, Test breakage, Minor documentation fixes
that impact the user experience.
Any change that is a fix to an issue that blocks developers from doing their Such fixes can be merged at any time after they have passed CI checks. Depending
daily work, for example CI breakage, Test breakage, Minor documentation fixes on the fix, severity, and availability of someone to review them (other than the
that impact the user experience. author) they can be merged with justification without review by one of the
project owners.
Such fixes can be merged at any time after they have passed CI checks. Depending
on the fix, severity, and availability of someone to review them (other than the
author) they can be merged with justification without review by one of the
project owners.
Trivial Trivial
+++++++ Trivial changes are those that appear obvious enough and do not require maintainer or code-owner
involvement. Such changes should not change the logic or the design of a
subsystem or component. For example a trivial change can be:
Trivial changes are those that appear obvious enough and do not require maintainer or code-owner - Documentation changes
involvement. Such changes should not change the logic or the design of a - Configuration changes
subsystem or component. For example a trivial change can be: - Minor Build System tweaks
- Minor optimization to code logic without changing the logic
- Documentation changes - Test changes and fixes
- Configuration changes - Sample modifications to support additional configuration or boards etc.
- Minor Build System tweaks
- Minor optimization to code logic without changing the logic
- Test changes and fixes
- Sample modifications to support additional configuration or boards etc.
Maintainer Maintainer
+++++++++++ Any changes that touch the logic or the original design of a subsystem or
component will need to be reviewed by the code owner or the designated subsystem
Any changes that touch the logic or the original design of a subsystem or maintainer. If the code changes is initiated by a contributor or developer other
component will need to be reviewed by the code owner or the designated subsystem than the owner the pull request needs to be assigned to the code owner who will
maintainer. If the code changes is initiated by a contributor or developer other have to drive the pull request to a mergeable state by giving feedback to the
than the owner the pull request needs to be assigned to the code owner who will author and asking for more reviews from other developers.
have to drive the pull request to a mergeable state by giving feedback to the
author and asking for more reviews from other developers.
Security Security
+++++++++++ Changes that appear to have an impact to the overall security of the system need
to be reviewed by a security expert from the security working group.
Changes that appear to have an impact to the overall security of the system need
to be reviewed by a security expert from the security working group.
TSC and Working Groups TSC and Working Groups
++++++++++++++++++++++ Changes that introduce new features or functionality or change the way the
overall system works need to be reviewed by the TSC or the responsible Working
Changes that introduce new features or functionality or change the way the Group. For example for :ref:`breaking API changes <breaking_api_changes>`, the
overall system works need to be reviewed by the TSC or the responsible Working proposal needs to be presented in the Architecture meeting so that the relevant
Group. For example for :ref:`breaking API changes <breaking_api_changes>`, the stakeholders are made aware of the change.
proposal needs to be presented in the Architecture meeting so that the relevant
stakeholders are made aware of the change.
A Pull-Request should have an Assignee A Pull-Request should have an Assignee
======================================= =======================================