Skip to content

Commit

Permalink
Update README.md with compositional structure in headings
Browse files Browse the repository at this point in the history
Signed-off-by: Anastas Stoyanovsky <[email protected]>
  • Loading branch information
anastasds authored Dec 20, 2024
1 parent db60e66 commit 67df891
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/rag/adrs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,18 +11,18 @@ This simple format, which is described below, has a surprising number of functio
* **Knowledge sharing**: The peer review phase allows sharing of expertise between team members.
* **Fewer meetings**: As decision making becomes asynchronous and as the team forms its social norms around the process, there should be less time required in meetings.

# When to write an ADR
## When to write an ADR

* A decision is being made that required discussion between two or more people.
* A decision is being made that required significant investigation.
* A decision is being proposed for feedback / discussion.
* A decision is being proposed that affects multiple teams.

# Template
## Template

[Here](template.md).

# Related Reading
## Related Reading

* [Suggestions for writing good ADRs](https://github.com/joelparkerhenderson/architecture-decision-record?tab=readme-ov-file#suggestions-for-writing-good-adrs)
* [ADRs at RedHat](https://www.redhat.com/architect/architecture-decision-records)
Expand Down

0 comments on commit 67df891

Please sign in to comment.