You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/adr/0001-use-adr.md
+7Lines changed: 7 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,15 +13,22 @@ Accepted
13
13
## Context
14
14
15
15
We need to record the architectural decisions made on this project.
16
+
ADR should stay at design/decision level,
17
+
without specific implementation details, code snippets
18
+
or step by step procedures.
16
19
17
20
This ADR is the template to use for all the others ADR:
18
21
customize this file to ensure it fits your needs and
19
22
ensure that all the ADRs follow the same format.
20
23
24
+
The context provides the basic information that leads
25
+
to decision, and may include the considered alternatives.
26
+
21
27
## Decision
22
28
23
29
-[ ] We will use Architecture Decision Records, as [described by Michael Nygard](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions).
24
30
-[ ] Decision is a list of checkboxes, to be marked as the decision is implemented.
31
+
-[ ] Avoid adding specific implementation details, code snippets or step-by-step procedures.
25
32
-[ ] Consequences section contain Pros and Cons of decision,
0 commit comments