2
2
title : TRG 2.04 - Leading product repository
3
3
---
4
4
5
- | Status | Created | Post-History |
6
- | --------| -------------| -----------------|
7
- | Active | 07-Mar-2023 | |
8
- | | 10-Jan-2023 | Initial release |
5
+ | Status | Created | Post-History |
6
+ | --------| -------------| ------------------------------------------------|
7
+ | Update | 12-Dez-2023 | add example leading repository reference links |
8
+ | Active | 07-Mar-2023 | |
9
+ | | 10-Jan-2023 | Initial release |
9
10
10
11
## Why
11
12
@@ -21,6 +22,8 @@ A good example when a product has a separate repository for frontend and backend
21
22
22
23
- productname: leading product repository
23
24
- README.md: contains the urls for the backend and frontend applications
25
+ - README.md: each repo follows our [ TRG 1.01] ( ../trg-1/trg-1-1.md ) about the README.md
26
+ - README.md: an [ example] ( #readme-example-section-for-a-leading-product-repository ) for a leading product repository
24
27
- contains the release of the product
25
28
- contains the [ product helm chart] ( ../trg-5/trg-5-08 )
26
29
- productname-A-frontend: the repository for the frontend application
@@ -33,3 +36,11 @@ A good example when a product has a separate repository for frontend and backend
33
36
- README.md contains the description of what the product does
34
37
- README.md contains the references/urls to the product's other repositories if they exist
35
38
- It ** should** contain the [ TRG 5.08 - Product Helm Chart] ( https://eclipse-tractusx.github.io/docs/release/trg-5/trg-5-08 )
39
+
40
+ ### README example section for a leading product repository
41
+
42
+ ``` markdown
43
+ Leading repository for [product-name](link_to_product_repository):
44
+ - [product component A](link_to_product_component_A_repository)
45
+ - [product component B](link_to_product_component_B_repository)
46
+ ```
0 commit comments