From b6a73414f8b7ab647b0ffe6b279c0f6451c4eabb Mon Sep 17 00:00:00 2001
From: Mathieu Leplatre <mathieu@mozilla.com>
Date: Tue, 4 Jul 2023 14:35:58 +0200
Subject: [PATCH] Add template and number prefix to ADRs docs

---
 ...{madr-fxa-ctms.md => 001-madr-fxa-ctms.md} |  0
 ...hips.md => 002-waitlists_relationships.md} |  0
 docs/adrs/template.md                         | 74 +++++++++++++++++++
 3 files changed, 74 insertions(+)
 rename docs/adrs/{madr-fxa-ctms.md => 001-madr-fxa-ctms.md} (100%)
 rename docs/adrs/{waitlists_relationships.md => 002-waitlists_relationships.md} (100%)
 create mode 100644 docs/adrs/template.md

diff --git a/docs/adrs/madr-fxa-ctms.md b/docs/adrs/001-madr-fxa-ctms.md
similarity index 100%
rename from docs/adrs/madr-fxa-ctms.md
rename to docs/adrs/001-madr-fxa-ctms.md
diff --git a/docs/adrs/waitlists_relationships.md b/docs/adrs/002-waitlists_relationships.md
similarity index 100%
rename from docs/adrs/waitlists_relationships.md
rename to docs/adrs/002-waitlists_relationships.md
diff --git a/docs/adrs/template.md b/docs/adrs/template.md
new file mode 100644
index 00000000..f4795ee3
--- /dev/null
+++ b/docs/adrs/template.md
@@ -0,0 +1,74 @@
+# [short title of solved problem and solution]
+
+- Status: [proposed | rejected | accepted | deprecated | … | superseded by
+  [ADR-0005](0005-example.md)] <!-- optional -->
+- Date: [YYYY-MM-DD when the decision was last updated] <!-- optional -->
+
+Tracking issue: [ticket/issue URL] <!-- optional -->
+
+## Context and Problem Statement
+
+[Describe the context and problem statement, e.g., in free form using two to
+three sentences. You may want to articulate the problem in form of a question.]
+
+## Decision Drivers <!-- optional -->
+
+- [driver 1, e.g., a force, facing concern, …]
+- [driver 2, e.g., a force, facing concern, …]
+- … <!-- numbers of drivers can vary -->
+
+## Considered Options
+
+1. [option 1]
+2. [option 2]
+3. [option 3]
+4. … <!-- numbers of options can vary -->
+
+## Decision Outcome
+
+Chosen option: "[option 1]", because [justification. e.g., only option, which
+meets k.o. criterion decision driver | which resolves force force | … | comes
+out best (see below)].
+
+### Positive Consequences <!-- optional -->
+
+- [e.g., improvement of quality attribute satisfaction, follow-up decisions
+  required, …]
+- …
+
+### Negative Consequences <!-- optional -->
+
+- [e.g., compromising quality attribute, follow-up decisions required, …]
+- …
+
+## Pros and Cons of the Options <!-- optional -->
+
+### Option 1 - …
+
+[example | description | pointer to more information | …] <!-- optional -->
+
+- Good, because [argument a]
+- Bad, because [argument b]
+- … <!-- numbers of pros and cons can vary -->
+
+### Option 2 - …
+
+[example | description | pointer to more information | …] <!-- optional -->
+
+- Good, because [argument a]
+- Bad, because [argument b]
+- … <!-- numbers of pros and cons can vary -->
+
+### Option 3 - …
+
+[example | description | pointer to more information | …] <!-- optional -->
+
+- Good, because [argument a]
+- Bad, because [argument b]
+- … <!-- numbers of pros and cons can vary -->
+
+## Links <!-- optional -->
+
+- [Link type] [Link to ADR]
+  <!-- example: Refined by [ADR-0005](0005-example.md) -->
+- … <!-- numbers of links can vary -->