Add architecture decision records #7221
Merged
Conversation
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
wmontwe
added
the
type: architecture
cketti
reviewed
Oct 5, 2023
Comment on lines
16
to
22
| We are proposing to create a new atomic design system where Material components are wrapped into our own 'atomic' | ||
| components. For instance, we would have components such as `AtomicButton`, `AtomicText`, etc. These atomic components | ||
| will encapsulate Material components with predefined styles and behaviors. | ||
|
|
||
| This approach will be taken further to develop more complex 'molecule' and 'organism' components by combining these | ||
| atomic components. We will also define 'templates' as layout structures and 'pages' as specific instances of these | ||
| templates to build a complete user interface. |
There was a problem hiding this comment.
This makes it sound like a proposal rather than a decision that was made.
I'm not sure it makes sense to specifically mention AtomicButton, AtomicText when our existing design system is using different names.
We should probably also link to the README in the designsystem folder: https://github.com/thundernest/k-9/blob/main/core/ui/compose/designsystem/README.md
There was a problem hiding this comment.
Right it is written as proposal, I split it into two commits to showcase a rewrite of a proposal to an accepted form.
wmontwe
force-pushed
the
add_architecture_decision_records
branch
from
d3818d4
to
9557966
Compare
wmontwe
force-pushed
the
add_architecture_decision_records
branch
from
9557966
to
89da8fe
Compare
cketti
approved these changes
Oct 6, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This adds architecture descision records (ADRs) to document important architectural changes and provide historical context for everyone participating in the project.
This adds 2 ADRs: