generated from digitalservicebund/remix-application-template
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Re-organise ADRs and add dito react adr
- Loading branch information
Showing
6 changed files
with
48 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
# 1. Record architecture decisions | ||
|
||
Date: 2024-05-16 | ||
|
||
## Status | ||
|
||
Accepted | ||
|
||
## Context | ||
|
||
We need to record the architectural decisions made on this project. | ||
|
||
## Decision | ||
|
||
We will use Architecture Decision Records, as [described by Michael Nygard](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions). | ||
|
||
## Consequences | ||
|
||
See Michael Nygard's article, linked above. For a lightweight ADR toolset, see Nat Pryce's [adr-tools](https://github.com/npryce/adr-tools). | ||
|
||
Furthermore, some additional clarification on how we use the sections of an ADR: | ||
|
||
- The `Context` provides information about the requirements of the decision topic and describes the considerations made, like pros and cons of different competing options. | ||
- The `Decision` clearly states what we will do and can contain a short reasoning that lead to the decision. | ||
- The `Consequences` lay out the resulting context; mentioning specific benefits, drawbacks and derived actions/mitigations. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
# 2. Use React as the frontend framework | ||
|
||
Date: 2024-05-16 | ||
|
||
## Status | ||
|
||
Accepted | ||
|
||
## Context | ||
|
||
The context is similar to the one described for the [tool-finder here](../../../tool-finder/doc/adr/0002-use-react.md). | ||
Additionally, the components already developed for the tool-finder should be re-used. | ||
|
||
## Decision | ||
|
||
We will use React as the frontend framework since it aligns well with the outlined requirements and considerations. | ||
|
||
## Consequences | ||
|
||
The consequences are similar to the ones described for the [tool-finder here](../../../tool-finder/doc/adr/0002-use-react.md). |
2 changes: 1 addition & 1 deletion
2
...ges/tool-finder/doc/adr/0003-use-react.md → ...ges/tool-finder/doc/adr/0002-use-react.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
# 3. Use React as the frontend framework | ||
# 2. Use React as the frontend framework | ||
|
||
Date: 2024-04-11 | ||
|
||
|
File renamed without changes.
File renamed without changes.