@@ -210,10 +210,10 @@ Developers are expected to fix issues and rework their patches and submit again.
210210
211211The CI infrastructure currently runs the following tests:
212212
213- - Run '' checkpatch'' for code style issues (can vote -1 on errors; see note)
213+ - Run `` checkpatch `` for code style issues (can vote -1 on errors; see note)
214214- Gitlint: Git commit style based on project requirements
215215- License Check: Check for conflicting licenses
216- - Run '' twister'' script
216+ - Run `` twister `` script
217217
218218 - Run kernel tests in QEMU (can vote -1 on errors)
219219 - Build various samples for different boards (can vote -1 on errors)
@@ -222,10 +222,12 @@ The CI infrastructure currently runs the following tests:
222222
223223.. note ::
224224
225- '' checkpatch'' is a Perl script that uses regular expressions to
225+ `` checkpatch `` is a Perl script that uses regular expressions to
226226 extract information that requires a C language parser to process
227227 accurately. As such it sometimes issues false positives. Known
228- cases include constructs like::
228+ cases include constructs like:
229+
230+ .. code-block :: c
229231
230232 static uint8_t __aligned(PAGE_SIZE) page_pool[PAGE_SIZE * POOL_PAGES];
231233 IOPCTL_Type *base = config->base;
@@ -264,46 +266,43 @@ These are the labels we currently have, grouped by applicability:
264266Labels applicable to issues only
265267================================
266268
267- * *priority: {high|medium|low} *
268-
269- To classify the impact and importance of a bug or
270- :ref: `feature <feature-tracking >`.
271-
272- Note: Issue priorities are generally set or changed during the bug-triage or TSC
273- meetings.
274-
275- * *Regression *
276-
277- Something, which was working, but does not anymore (bug subtype).
278-
279- * *Enhancement *
280-
281- Changes/Updates/Additions to existing :ref: `features <feature-tracking >`.
269+ .. list-table ::
270+ :header-rows: 1
282271
283- * *Feature request *
272+ * - Label
273+ - Description
284274
285- A request for a new :ref: `feature <feature-tracking >`.
275+ * - :guilabel: `priority: {high|medium|low} `
276+ - To classify the impact and importance of a bug or
277+ :ref: `feature <feature-tracking >`.
286278
287- * *Feature *
279+ Note: Issue priorities are generally set or changed during the bug-triage or TSC
280+ meetings.
288281
289- A :ref: `planned feature<feature-tracking> ` with a milestone.
282+ * - :guilabel: `Regression `
283+ - Something, which was working, but does not anymore (bug subtype).
290284
291- * *Hardware Support *
285+ * - :guilabel: `Enhancement `
286+ - Changes/Updates/Additions to existing :ref: `features <feature-tracking >`.
292287
293- Covers porting an existing feature (including Zephyr itself) to new hardware.
288+ * - :guilabel: `Feature request `
289+ - A request for a new :ref: `feature <feature-tracking >`.
294290
295- * *Duplicate *
291+ * - :guilabel: `Feature `
292+ - A :ref: `planned feature<feature-tracking> ` with a milestone.
296293
297- This issue is a duplicate of another issue (please specify).
294+ * - :guilabel: `Hardware Support `
295+ - Covers porting an existing feature (including Zephyr itself) to new hardware.
298296
299- * *Good first issue *
297+ * - :guilabel: `Duplicate `
298+ - This issue is a duplicate of another issue (please specify).
300299
301- Good for a first time contributor to take.
300+ * - :guilabel: `Good first issue `
301+ - Good for a first time contributor to take.
302302
303- * *Release Notes *
304-
305- Issues that need to be mentioned in release notes as known issues with
306- additional information.
303+ * - :guilabel: `Release Notes `
304+ - Issues that need to be mentioned in release notes as known issues with
305+ additional information.
307306
308307Any issue must be classified and labeled as either *Bug *, *Enhancement *, *RFC *,
309308*Feature *, *Feature Request * or *Hardware Support *. More information on how
@@ -315,36 +314,37 @@ Labels applicable to pull requests only
315314
316315The issue or PR describes a change to a stable API.
317316
318- * *Hotfix *
319-
320- Fix for an issue blocking development.
321-
322- * *Trivial *
323-
324- * *Maintainer *
325-
326- Maintainer review required.
327-
328- * *Security Review *
317+ .. list-table ::
318+ :header-rows: 1
329319
330- To be reviewed by a security expert.
320+ * - Label
321+ - Description
331322
332- * *DNM *
323+ * - :guilabel: `Hotfix `
324+ - Fix for an issue blocking development.
333325
334- This PR should not be merged (Do Not Merge). For work in progress, GitHub
335- "draft" PRs are preferred.
326+ * - :guilabel: `Trivial `
327+ - Simple changes that can have shorter review time and be reviewed by anyone, i.e. typos,
328+ straightforward one-liner bug fixes, etc.
336329
337- * *Needs review *
330+ * - :guilabel: `Maintainer `
331+ - Maintainer review required.
338332
339- The PR needs attention from the maintainers.
333+ * - :guilabel: `Security Review `
334+ - To be reviewed by a security expert.
340335
341- * *Backport *
336+ * - :guilabel: `DNM `
337+ - This PR should not be merged (Do Not Merge). For work in progress, GitHub
338+ "draft" PRs are preferred.
342339
343- The PR is a backport or should be backported.
340+ * - :guilabel: `Needs review `
341+ - The PR needs attention from the maintainers.
344342
345- * *Licensing *
343+ * - :guilabel: `Backport `
344+ - The PR is a backport or should be backported.
346345
347- The PR has licensing issues which require a licensing expert to review it.
346+ * - :guilabel: `Licensing `
347+ - The PR has licensing issues which require a licensing expert to review it.
348348
349349.. note ::
350350 For all labels applicable to PRs: Please note that the label, together with
@@ -355,74 +355,66 @@ The PR has licensing issues which require a licensing expert to review it.
355355Labels applicable to both pull requests and issues
356356==================================================
357357
358- * *area: * *
359-
360- Indicates Zephyr subsystems (e.g, *area: Kernel *, *area: I2C *,
361- *area: Memory Management *), project functions (e.g., *area: Debugging *,
362- *area: Documentation *, *area: Process *), or other categories (e.g.,
363- *area: Coding Style *, *area: MISRA-C *) affected by the bug or the pull request.
364-
365- An area maintainer should be able to filter by an area label and find all issues
366- and PRs which relate to that area.
367-
368- * *platform: * *
369-
370- An issue or PR which affects only a particular platform.
371-
372- * *dev-review *
373-
374- The issue is to be discussed in the following `dev-review `_ if time
375- permits.
376-
377- .. _`dev-review` : https://github.com/zephyrproject-rtos/zephyr/wiki/Zephyr-Committee-and-Working-Group-Meetings#zephyr-dev-meeting
378-
379- * *TSC *
380-
381- TSC stands for Technical Steering Committee. The issue is to be discussed in the
382- following `TSC meeting `_ if time permits.
383-
384- .. _`TSC meeting` : https://github.com/zephyrproject-rtos/zephyr/wiki/Zephyr-Committee-and-Working-Group-Meetings#technical-steering-committee-tsc
385-
386- * *Breaking API Change *
387-
388- The issue or PR describes a breaking change to a stable API. See additional information
389- in :ref: `breaking_api_changes `.
358+ .. list-table ::
359+ :header-rows: 1
390360
391- * *Bug *
361+ * - Label
362+ - Description
392363
393- The issue is a bug, or the PR is fixing a bug.
364+ * - :guilabel: `area: {area-name} `
365+ - Indicates Zephyr subsystems (e.g, :guilabel: `area: Kernel `, :guilabel: `area: I2C `,
366+ :guilabel: `area: Memory Management `), project functions (e.g., :guilabel: `area: Debugging `,
367+ :guilabel: `area: Documentation `, :guilabel: `area: Process `), or other categories (e.g.,
368+ :guilabel: `area: Coding Style `, :guilabel: `area: MISRA-C `) affected by the bug or the pull request.
394369
395- * *Coverity *
370+ An area maintainer should be able to filter by an area label and find all issues
371+ and PRs which relate to that area.
396372
397- A Coverity detected issue or its fix.
373+ * - :guilabel: `platform: {platform-name} `
374+ - An issue or PR which affects only a particular platform.
398375
399- * *Waiting for response *
376+ * - :guilabel: `dev-review `
377+ - The issue is to be discussed in the following `dev-review `_ if time
378+ permits.
400379
401- The Zephyr developers are waiting for the submitter to respond to a question, or
402- address an issue.
380+ .. _`dev-review` : https://github.com/zephyrproject-rtos/zephyr/wiki/Zephyr-Committee-and-Working-Group-Meetings#zephyr-dev-meeting
403381
404- * *Blocked *
382+ * - :guilabel: `TSC `
383+ - TSC stands for Technical Steering Committee. The issue is to be discussed in the
384+ following `TSC meeting `_ if time permits.
405385
406- Blocked by another PR or issue.
386+ .. _ `TSC meeting` : https://github.com/zephyrproject-rtos/zephyr/wiki/Zephyr-Committee-and-Working-Group-Meetings#technical-steering-committee-tsc
407387
408- * *Stale *
388+ * - :guilabel: `Breaking API Change `
389+ - The issue or PR describes a breaking change to a stable API. See additional information
390+ in :ref: `breaking_api_changes `.
409391
410- An issue or a PR which seems abandoned, and requires attention by the author.
392+ * - :guilabel: `bug `
393+ - The issue is a bug, or the PR is fixing a bug.
411394
412- * *In progress *
395+ * - :guilabel: `Coverity `
396+ - A Coverity detected issue or its fix.
413397
414- For PRs: is work in progress and should not be merged yet. For issues: Is being
415- worked on.
398+ * - :guilabel: `Waiting for response `
399+ - The Zephyr developers are waiting for the submitter to respond to a question, or
400+ address an issue.
416401
417- * *RFC *
402+ * - :guilabel: `Blocked `
403+ - Blocked by another PR or issue.
418404
419- The author would like input from the community. For a PR it should be considered
420- a draft .
405+ * - :guilabel: ` Stale `
406+ - An issue or a PR which seems abandoned, and requires attention by the author .
421407
422- * *LTS *
408+ * - :guilabel: `In progress `
409+ - For PRs: is work in progress and should not be merged yet. For issues: Is being
410+ worked on.
423411
424- Long term release branch related.
412+ * - :guilabel: `RFC `
413+ - The author would like input from the community. For a PR it should be considered
414+ a draft.
425415
426- * *EXT *
416+ * - :guilabel: `LTS `
417+ - Long term release branch related.
427418
428- Related to an external component.
419+ * - :guilabel: `EXT `
420+ - Related to an external component.
0 commit comments