Skip to content
Snippets Groups Projects
Commit 817e3e3f authored by Luca Favaretto's avatar Luca Favaretto
Browse files

Add common nomenclature for new issue


Signed-off-by: default avatarLuca Favaretto <luca.favaretto@kalpa.it>
parent b30990d1
No related merge requests found
...@@ -97,6 +97,47 @@ In terms of file format, the project unifies its documentation as `ReStructuredT ...@@ -97,6 +97,47 @@ In terms of file format, the project unifies its documentation as `ReStructuredT
As a rule of thumb, anything that ends up compiled in the project documentation is to maintain the RestructuredText file format. Text files that are not meant to be compiled as part of the project's documentation can be written in [Markdown](https://daringfireball.net/projects/markdown/). For example, a repository `README` file can be written in Markdown as it doesn't end up compiled in the project-wide documentation. As a rule of thumb, anything that ends up compiled in the project documentation is to maintain the RestructuredText file format. Text files that are not meant to be compiled as part of the project's documentation can be written in [Markdown](https://daringfireball.net/projects/markdown/). For example, a repository `README` file can be written in Markdown as it doesn't end up compiled in the project-wide documentation.
## Nomenclature for new issue
In Oniro Project, for the opening of a new `Issue::Bug` the team decided to adopt a common nomenclature to apply to the title of the new Issue. Depending on the scope to which the issue refers, two 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
[Miscellaneous][$BOARD] - $Title
Example:
[Maintenance][SECO C61] - 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 - MISCELLANEOUS][$BOARD] - $Title
Examples:
[CATS - HW] - Black screen when flashing the image
[ENERGY GATEWAY - OTA][Raspberry Pi 4B] - Can't upload the image via OTA
# REUSE Compliance # REUSE Compliance
## SPDX Information and REUSE Standard ## SPDX Information and REUSE Standard
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment