From 75cb88ac421045a96b20b8f26e5f2b0f7367afb2 Mon Sep 17 00:00:00 2001 From: Tomasz Barwicki Date: Wed, 6 Dec 2023 11:20:58 +0100 Subject: [PATCH 1/3] docs: TRG 2.03 update --- docs/release/trg-2/trg-2-3.md | 25 +++++++++++++++---------- 1 file changed, 15 insertions(+), 10 deletions(-) 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 From d33de6cf387c14c09cf075e3cf43bed38e98fc8f Mon Sep 17 00:00:00 2001 From: Tomasz Barwicki Date: Wed, 6 Dec 2023 11:33:58 +0100 Subject: [PATCH 2/3] fix: remove blank line --- docs/release/trg-2/trg-2-3.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/release/trg-2/trg-2-3.md b/docs/release/trg-2/trg-2-3.md index 934367f74b3..5d8d5b3d024 100644 --- a/docs/release/trg-2/trg-2-3.md +++ b/docs/release/trg-2/trg-2-3.md @@ -36,7 +36,6 @@ AUTHORS.md INSTALL.md ``` - ### Directories #### /docs From d005bd69be73613fbd8ffc16c2397fb9a5e37bb4 Mon Sep 17 00:00:00 2001 From: Tomasz Barwicki Date: Thu, 14 Dec 2023 15:18:40 +0100 Subject: [PATCH 3/3] fix: remove open source and eclipse foundation wording --- docs/release/trg-2/trg-2-3.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/release/trg-2/trg-2-3.md b/docs/release/trg-2/trg-2-3.md index 5d8d5b3d024..8dc45fbda60 100644 --- a/docs/release/trg-2/trg-2-3.md +++ b/docs/release/trg-2/trg-2-3.md @@ -11,7 +11,7 @@ title: TRG 2.03 - Repo structure ## Why -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. +In order to foster consistency, collaboration and ease of navigation, adhereing to a specific repository structure 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. ## Description