enhancement(docs): describe what and why ADRs #1518
Merged
Conversation
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
fschade
force-pushed
the
docs-adr-readme
branch
2 times, most recently
from
de80924 to
7e8d4d4
Compare
aduffeck
approved these changes
Sep 22, 2025
Contributor
aduffeck
left a comment
aduffeck
left a comment
There was a problem hiding this comment.
Just some nitpicks, lgtm. Love the use of the oxford comma 👍 😄
fschade
force-pushed
the
docs-adr-readme
branch
from
7e8d4d4 to
5f675ee
Compare
Co-authored-by: Andre Duffeck <aduffeck@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Description
ADRs are a good way to document decisions and provide some background of the hows and whys.
We started using them already, but in my opinion there where some weak spots on when to write such ADRs and how to structure them.
https://github.com/opencloud-eu/internal/issues/178