Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: TRG 2.03 update #529

Merged
merged 3 commits into from
Jan 10, 2024
Merged

docs: TRG 2.03 update #529

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
75cb88a
docs: TRG 2.03 update
tomaszbarwicki Dec 6, 2023
d33de6c
fix: remove blank line
tomaszbarwicki Dec 6, 2023
d005bd6
fix: remove open source and eclipse foundation wording
tomaszbarwicki Dec 14, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 14 additions & 10 deletions docs/release/trg-2/trg-2-3.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 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

Expand All @@ -21,17 +20,22 @@ 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
FaGru3n marked this conversation as resolved.
Show resolved Hide resolved
```

### Directories

#### /docs
Expand Down