Replies: 6 comments 2 replies
-
|
@preardon @holytshirt @jonnyollifflee Thoughts? |
Beta Was this translation helpful? Give feedback.
-
|
I like the idea as it helps answer questions like "Why do you it this way?" which we often get to people coming to Brighter for the first time. |
Beta Was this translation helpful? Give feedback.
-
|
I am a big fan of ADRs for a variety of reasons, From recalling why we chose something to documentation for the community. |
Beta Was this translation helpful? Give feedback.
-
|
I love them too!
…On Wed, 2 Feb 2022, 11:50 Paul Reardon, ***@***.***> wrote:
I am a big fan of ADRs for a variety of reasons, From recalling why we
chose something to documentation for the community.
—
Reply to this email directly, view it on GitHub
<#1967 (reply in thread)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AAAWAFHNRCCELGF3GSOKC6TUZELAVANCNFSM5NLX73UQ>
.
Triage notifications on the go with GitHub Mobile for iOS
<https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675>
or Android
<https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub>.
You are receiving this because you were mentioned.Message ID:
***@***.***
com>
|
Beta Was this translation helpful? Give feedback.
-
|
OK, incoming PR using https://github.com/npryce/adr-tools I'll ping you all as reviewers |
Beta Was this translation helpful? Give feedback.
-
|
LOL, we already have them: https://github.com/BrighterCommand/Brighter/tree/master/doc/adr |
Beta Was this translation helpful? Give feedback.
-
|
OK, that is a bad sign about adoption, but we should use them more |
Beta Was this translation helpful? Give feedback.
-
|
So maybe we should discuss: what ADRs should we backfill with i.e. what do we need to record for understanding where we are? |
Beta Was this translation helpful? Give feedback.
-
Context
It is hard to understand from the codebase why architectural decisions were taken in Brighter - such as use of a single-threaded message pump. This can lead to wasted effort and energy as folks raise PRs to fix "issues" they see, rather than starting by reviewing the existing decision and discussing it
Decision
Brighter should use ADRs to document its decisions. We should seed this with a number of ADRs to represent existing decisions that it would be helpful to understand.
Status
Under Discussion
Consequences
It would be possible to understand the why of Brighter
Beta Was this translation helpful? Give feedback.
All reactions