Skip to content
Snippets Groups Projects

Add common nomenclature for new issue

Open Luca Favaretto requested to merge lucafavaretto/docs:nomenclature into main
1 file
+ 76
1
Compare changes
  • Side-by-side
  • Inline
@@ -7,6 +7,9 @@
@@ -7,6 +7,9 @@
Bug Handling Process
Bug Handling Process
####################
####################
 
.. contents::
 
:depth: 3
 
Overview
Overview
********
********
@@ -20,7 +23,79 @@ How to Report a Bug?
@@ -20,7 +23,79 @@ How to Report a Bug?
If you think you have found a bug in our distribution, please file a bug report
If you think you have found a bug in our distribution, please file a bug report
in our bug tracker and in the project that you think is the source of the
in our bug tracker and in the project that you think is the source of the
issue. Use the provided template:
issue.
 
 
Nomenclature for a new issue
 
^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
In |main_project_name|, for the opening of a new `Issue::Bug` the team decided to adopt
 
a common nomenclature to apply to the title of each new issue.
 
Depending on the scope to which the issue refers, three options are defined.
 
 
Option 1 - Board-related
 
------------------------
 
 
When the issue is opened related to a specific board, the parameters to be given
 
are: **Domain** and **Board**.
 
 
| [MAINTENANCE][$BOARD] - $Title
 
| [NETWORK][$BOARD] - $Title
 
| [OpenHarmony][$BOARD] - $Title
 
| [OTA][$BOARD] - $Title
 
| [SECURITY][$BOARD] - $Title
 
| [PERFORMANCE][$BOARD] - $Title
 
| [HW][$BOARD] - $Title
 
| [TOOLCHAIN][$BOARD] - $Title
 
| [MISC][$BOARD] - $Title
 
 
*Example:*
 
 
[Maintenance][BOARD X] - Build failed due to ModemManager error
 
 
Option 2 - Blueprint related
 
----------------------------
 
 
When the issue is opened related to a specific blueprint, the parameters to be given
 
are: **Blueprint** and **Domain**; if necessary even **Board** (when Blueprint has
 
more than one board in the configuration. To be omitted if there is only one board).
 
 
| [$BP - MAINTENANCE][$BOARD] - $Title
 
| [$BP - NETWORK][$BOARD] - $Title
 
| [$BP - OpenHarmony][$BOARD] - $Title
 
| [$BP - OTA][$BOARD] - $Title
 
| [$BP - SECURITY][$BOARD] - $Title
 
| [$BP - PERFORMANCE][$BOARD] - $Title
 
| [$BP - HW][$BOARD] - $Title
 
| [$BP - TOOLCHAIN][$BOARD] - $Title
 
| [$BP - MISC][$BOARD] - $Title
 
 
*Examples:*
 
 
| [CATS - HW] - Black screen when flashing the image
 
| [ENERGY GATEWAY - OTA][Raspberry Pi 4B] - Can't upload the image via OTA
 
 
Option 3 - Domain related
 
-------------------------
 
 
When the issue isn't related to a specific blueprint or board, the parameters
 
to be given is **Domain**.
 
 
| [MAINTENANCE] - $Title
 
| [NETWORK] - $Title
 
| [OpenHarmony] - $Title
 
| [OTA] - $Title
 
| [SECURITY] - $Title
 
| [PERFORMANCE] - $Title
 
| [HW] - $Title
 
| [TOOLCHAIN] - $Title
 
| [MISC] - $Title
 
 
*Example:*
 
 
[SECURITY] - Security configuration error on Linux Kernel
 
 
Bug template
 
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
To fill the information of the issue use the provided template:
* The module affected
* The module affected
* What is the action to reproduce the bug? (Steps to reproduce)
* What is the action to reproduce the bug? (Steps to reproduce)
Loading