Skip to content

Commit 524b5b4

Browse files
committed
conventions
1 parent 6869264 commit 524b5b4

6 files changed

+8
-2
lines changed

architecture-decision-records/README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,18 @@ The purpose is to provide transparency and enable a broader team to contribute t
99

1010
Use the [ADR template](0_template.md).
1111

12+
### Illustrations
13+
14+
Use [mermaid](https://www.mermaidchart.com/app/dashboard) within the markdown files for technical illustrations instead of external assets.
15+
1216
### Naming
1317

14-
The files should be named using this conventions `<component>-ADR-<number>-<name>.md`.
18+
The files should be named using this conventions `<component>-ADR-<number>-<name>.md`.
19+
The `<number>` consists of 3 digits. Use leading zeros if necessary.
1520
The `CloudOperators` component is used for ADRs of general nature.
21+
1622
Example:
17-
* `Greenhouse-ADR-1-logical_authorization_concept_for_plugins.md`
23+
* `Greenhouse-ADR-001-logical_authorization_concept_for_plugins.md`
1824
* `CloudOperators-ADR-<number>-<name>.md`
1925

2026
### Contributing

0 commit comments

Comments
 (0)