Skip to content

Commit

Permalink
docs: TRG 2.03 update
Browse files Browse the repository at this point in the history
  • Loading branch information
tomaszbarwicki committed Dec 6, 2023
1 parent f0603cb commit 75cb88a
Showing 1 changed file with 15 additions and 10 deletions.
25 changes: 15 additions & 10 deletions docs/release/trg-2/trg-2-3.md
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 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

Expand All @@ -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
Expand Down

0 comments on commit 75cb88a

Please sign in to comment.