diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a90e3ec4124ba82177a734614d9304afdce0b293..43b36ec9b9f0c17486dff2132d9e54300c2cedf1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -99,21 +99,21 @@ As a rule of thumb, anything that ends up compiled in the project 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. +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 + [MAINTENANCE][$BOARD] - $Title + [NETWORK][$BOARD] - $Title [OpenHarmony][$BOARD] - $Title [OTA][$BOARD] - $Title - [Security][$BOARD] - $Title - [Performance][$BOARD] - $Title + [SECURITY][$BOARD] - $Title + [PERFORMANCE][$BOARD] - $Title [HW][$BOARD] - $Title - [Toolchain][$BOARD] - $Title - [Miscellaneous][$BOARD] - $Title + [TOOLCHAIN][$BOARD] - $Title + [MISCELLANEOUS][$BOARD] - $Title Example: @@ -138,6 +138,24 @@ 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