diff --git a/docs/release/trg-2/trg-2-3.md b/docs/release/trg-2/trg-2-3.md index 33adf06e5c1..934367f74b3 100644 --- a/docs/release/trg-2/trg-2-3.md +++ b/docs/release/trg-2/trg-2-3.md @@ -2,17 +2,16 @@ title: TRG 2.03 - Repo structure --- -| Status | Created | Post-History | -|--------|-------------|--------------------------------------------| -| Active | 25-Nov-2022 | adjustments to DEPENDENCY, LICENSE, NOTICE | -| | 24-Nov-2022 | add FOSS/Eclipse related basic files | -| | 10-Nov-2022 | Initial release | +| Status | Created | Post-History | +|--------|-------------|-----------------------------------------------| +| Active | 06-Dec-2023 | reword Why section + highlight optional files | +| | 25-Nov-2022 | adjustments to DEPENDENCY, LICENSE, NOTICE | +| | 24-Nov-2022 | add FOSS/Eclipse related basic files | +| | 10-Nov-2022 | Initial release | ## Why -We are part of the Eclipse Foundation which requires compliance to the Eclipse Foundation rules. This also includes open and collaborative Open Source working model. - -Therefore, we need to follow the Eclipse Foundation and Open Source standards. +In order to foster consistency, collaboration and ease of navigation, adhereing to a specific open source project repository structure within Eclipse Foundation is important. The structure serves a standardized framework, facilitating efficient development by providing a clear organisation of essential project components. By adopting recommended layout of files and directories, contributors can quickly locate resources such as source code, documentation and configuration files. Moreover specified repository structure aligns with industry best practices under Eclipse Foundation governance. ## Description @@ -21,17 +20,23 @@ All repositories **must** contain the following files and folders: ```shell /docs /charts -AUTHORS.md CODE_OF_CONDUCT.md CONTRIBUTING.md DEPENDENCIES LICENSE NOTICE.md README.md -INSTALL.md SECURITY.md ``` +Recommended but optional: + +```shell +AUTHORS.md +INSTALL.md +``` + + ### Directories #### /docs