diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 98e769547ba10de7fa8c1c891f2ee788142591a8..43b36ec9b9f0c17486dff2132d9e54300c2cedf1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -97,6 +97,65 @@ 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. +## 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, 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 + [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 + +### Option 3 - Domain related + +When the issue isn't opened 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 + [MISCELLANEOUS] - $Title + +Examples: + + [SECURITY] - Security configuration error on Linux Kernel + # REUSE Compliance ## SPDX Information and REUSE Standard