-
Notifications
You must be signed in to change notification settings - Fork 15
Introduce ADRs for the project #365
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
andregasser
wants to merge
3
commits into
master
Choose a base branch
from
introduce-adrs
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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,35 @@ | ||
| # ADR Process | ||
|
|
||
| ## Overview | ||
|
|
||
| When writing/maintaining software, developers often have to make architectural design decisions. In the BigBone project, | ||
| we use Architectural Decision Records (ADRs) to log the outcome of the decision-making process behind. ADRs are | ||
| typically created for design decisions that address a functional or non-functional requirement that is architecturally | ||
| significant. Hence, we can view them as journals, akin to meeting outcome summaries or discussion notes. ADRs help | ||
| future developers to better understand why things are done in a particular way. | ||
|
|
||
| ## Process | ||
|
|
||
| ## ADR Creation | ||
|
|
||
| The process for discussing architectural or design topics is initiated by first identifying a need for discussing it. | ||
| Once the team has agreed that there is a real need for having an in-depth discussion, the process is initiated as | ||
| follows: | ||
|
|
||
| 1. The initiator of the topic creates a new discussion thread under the "Architecture & Design" category. The topic is | ||
| discussed on the discussion thread and members agree on a decision to be taken. | ||
| 2. The outcome of the discussion should be recorded in a new ADR inside the `/adr` folder. Please use the provided | ||
| template for this (`adr-template.md`). Give your ADR a meaningful name, such as `0001-exception-handling.md`. For | ||
| every future ADR, the number should be incremented by 1. | ||
| 3. Also please place a link in the discussion thread that points to the newly created ADR. | ||
| 4. If concrete action needs to be taken, please open issues for all of them and refer to the ADR. | ||
|
|
||
| ## ADR Review | ||
|
|
||
|
|
||
|
|
||
| ## More on ADRs | ||
|
|
||
| - https://adr.github.io/ | ||
| - https://www.ozimmer.ch/practices/2023/04/03/ADRCreation.html | ||
| - https://docs.aws.amazon.com/prescriptive-guidance/latest/architectural-decision-records/adr-process.html |
This file contains hidden or 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,22 @@ | ||
| # ADR <Four digit number>: <Title> | ||
|
|
||
| ## Status | ||
|
|
||
| The status of this ADR. Valid statuses are: | ||
|
|
||
| - Proposed: ADRs in the Proposed state are ready for review. | ||
| - Accepted: An ADR which was accepted by the team. | ||
| - Rejected: An ADR which was rejected by the team. | ||
| - Superseded: An ADR which was replaced by a newer one. | ||
|
|
||
| ## Context | ||
|
|
||
| What is the issue that we're seeing that is motivating this decision or change? | ||
|
|
||
| ## Decision | ||
|
|
||
| What is the change that we're proposing and/or doing? | ||
|
|
||
| ## Consequences | ||
|
|
||
| What becomes easier or more difficult to do because of this change? | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"Context" should probably include a link to the discussion thread that led to the ADR.