-
-
Notifications
You must be signed in to change notification settings - Fork 94
[DRAFT] [WIP] Architecture Decision Records #170
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
base: master
Are you sure you want to change the base?
Changes from all commits
9d92fa9
f4f872f
796ec5d
affa3e1
128d434
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| --- | ||
| title: Architecture Decision Record - TEMPLATE | ||
| icon: fal fa-cogs | ||
| excerpt: > | ||
| Brief description of the decision | ||
| tags: | ||
| - architecture | ||
| --- | ||
|
|
||
| # TEMPLATE | ||
|
|
||
| ## Introduction | ||
| Some background about the possible decisions | ||
|
|
||
| ### Assumptions | ||
| A list of all assumptions that are being made | ||
|
|
||
| ### Constraints | ||
| A list of constraints that the decision must conform to | ||
|
|
||
| ## Outcomes investigated | ||
|
|
||
| ### Decision 1 | ||
| Detailed expaination of what changes would need to be made | ||
|
|
||
| #### Benifits | ||
| Benifits of this decision | ||
|
|
||
| #### Drawbacks | ||
| Drawbacks of this decision | ||
|
|
||
| ### Decision 2 | ||
| Detailed expaination of what changes would need to be made | ||
|
|
||
| #### Benifits | ||
| Benifits of this decision | ||
|
|
||
| #### Drawbacks | ||
| Drawbacks of this decision | ||
|
|
||
| ## Outcome | ||
| Decision made: DECISION | ||
|
|
||
| Reasoning for this decision being made. | ||
|
|
||
| ## References | ||
| Github Issue(s): [####](link) [####](link) [####](link) | ||
|
|
||
| Github Pull Request(s): [####](link) [####](link) [####](link) | ||
|
|
||
| Additional reference material supporting decision | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| --- | ||
| title: Architecture Decision Records | ||
| icon: fal fa-cogs | ||
| excerpt: > | ||
| Log of architectural decisions that have been made and their reasoning | ||
| tags: | ||
| - architecture | ||
| --- | ||
|
|
||
| # Architecture Decision Records | ||
| The following are a list of decisions that have been made regarding the architecture of the Tenancy package. | ||
|
|
||
| ## 1.x | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. All of these should be listed under |
||
| ** Use of Config Files ** | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. No need to use capitalized letters |
||
|
|
||
| ** Disallow the ordering of Affects ** | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Disallow sounds so rude, "Do not support", sounds slightly better |
||
|
|
||
| ## 0.x | ||
|
|
||
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.
Add a summary please