Merge pull request #11 from MinBZK/fix/adr-template

Fix ADR Template
MinBZK · Feb 19, 2024 · 9ae0202 · 9ae0202
2 parents 84c5976 + 36fa36d
commit 9ae0202
Show file tree

Hide file tree

Showing 2 changed files with 26 additions and 1 deletion.
diff --git a/docs/ADRs/0001-adrs.md b/docs/ADRs/0001-adrs.md
@@ -40,4 +40,29 @@ Use the template below to add an ADR:
             - 0001-first
             - 0002-second
 ---
+
+## Context
+
+What is the issue that we're seeing that is motivating this decision or change?
+
+## Assumptions
+
+Anything that could cause problems if untrue now or later
+
+## Decision
+
+What is the change that we're proposing and/or doing?
+
+## Risks
+
+Anything that could cause malfunction, delay, or other negative impacts
+
+## Consequences
+
+What becomes easier or more difficult to do because of this change?
+
+## More Information
+
+Provide additional evidence/confidence for the decision outcome
+Links to other decisions and resources might here appear as well.
 ```
diff --git a/docs/index.md b/docs/index.md
@@ -8,7 +8,7 @@ Here we are documenting the processes of the AI Validation Team at the Ministry
 
 !!! info "Disclaimer"
 
-    This documention is under development
+    This documentation is under development
 
 ## Contribute?