From 3a03a4100a14174999e401adf50d044702f66d42 Mon Sep 17 00:00:00 2001 From: blam Date: Sat, 9 Jan 2021 19:54:44 +0100 Subject: [PATCH 1/5] chore: actually add the adr template which appears to have gone missing in the repo --- docs/architecture-decisions/0000-template.md | 22 ++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 docs/architecture-decisions/0000-template.md diff --git a/docs/architecture-decisions/0000-template.md b/docs/architecture-decisions/0000-template.md new file mode 100644 index 0000000000..d1ad78ffc8 --- /dev/null +++ b/docs/architecture-decisions/0000-template.md @@ -0,0 +1,22 @@ +# ADR 0000: [title] + + + +## Status + + + +## Context + + + +## Decision + + + +## Consequences + + + + From 3254b55617918703fbd811bda1841944538ab2e3 Mon Sep 17 00:00:00 2001 From: blam Date: Sat, 9 Jan 2021 23:00:05 +0100 Subject: [PATCH 2/5] chore: fixing code review comments to align with better numbers --- docs/architecture-decisions/0000-template.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/architecture-decisions/0000-template.md b/docs/architecture-decisions/0000-template.md index d1ad78ffc8..d45faefb80 100644 --- a/docs/architecture-decisions/0000-template.md +++ b/docs/architecture-decisions/0000-template.md @@ -1,6 +1,6 @@ -# ADR 0000: [title] +# ADR0000: [title] - + ## Status From 38c2f1be56f9d974a6b0451b50bdf206ee462203 Mon Sep 17 00:00:00 2001 From: blam Date: Sat, 9 Jan 2021 23:13:49 +0100 Subject: [PATCH 3/5] chore: add sample preamble --- docs/architecture-decisions/0000-template.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/docs/architecture-decisions/0000-template.md b/docs/architecture-decisions/0000-template.md index d45faefb80..ebbcef6aaa 100644 --- a/docs/architecture-decisions/0000-template.md +++ b/docs/architecture-decisions/0000-template.md @@ -1,6 +1,16 @@ -# ADR0000: [title] +--- +id: adrs-adr000 +title: ADR000: [TITLE] +description: Architecture Decision Record (ADR) for [TITLE] [DESCRIPTION] +--- - +| Created | Status | +| ---------- | ------ | +| YYYY-MM-DD | Open | | + +# ADR000: [title] + + ## Status From 47814df6f48a89c2118821bfc44d144218f6c988 Mon Sep 17 00:00:00 2001 From: blam Date: Sat, 9 Jan 2021 23:14:40 +0100 Subject: [PATCH 4/5] chore: remove superfluous comment --- docs/architecture-decisions/0000-template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/architecture-decisions/0000-template.md b/docs/architecture-decisions/0000-template.md index ebbcef6aaa..783db8e4bc 100644 --- a/docs/architecture-decisions/0000-template.md +++ b/docs/architecture-decisions/0000-template.md @@ -6,7 +6,7 @@ description: Architecture Decision Record (ADR) for [TITLE] [DESCRIPTION] | Created | Status | | ---------- | ------ | -| YYYY-MM-DD | Open | | +| YYYY-MM-DD | Open | # ADR000: [title] From 6cd4a99261add9032e2815f9f2d3ee47fd14f325 Mon Sep 17 00:00:00 2001 From: blam Date: Sat, 9 Jan 2021 23:18:14 +0100 Subject: [PATCH 5/5] chore: update documentation around ADR and the template skeleton --- .../{0000-template.md => adr000-template.md} | 0 docs/architecture-decisions/index.md | 5 +++-- 2 files changed, 3 insertions(+), 2 deletions(-) rename docs/architecture-decisions/{0000-template.md => adr000-template.md} (100%) diff --git a/docs/architecture-decisions/0000-template.md b/docs/architecture-decisions/adr000-template.md similarity index 100% rename from docs/architecture-decisions/0000-template.md rename to docs/architecture-decisions/adr000-template.md diff --git a/docs/architecture-decisions/index.md b/docs/architecture-decisions/index.md index 3211f37550..f852170b1e 100644 --- a/docs/architecture-decisions/index.md +++ b/docs/architecture-decisions/index.md @@ -18,8 +18,9 @@ Records should be stored under the `architecture-decisions` directory. ### Creating an ADR -- Copy `0000-template.md` to `docs/architecture-decisions/0000-my-decision.md` - (my-decision should be descriptive. Do not assign an ADR number.) +- Copy `docs/architecture-decisions/adr000-template.md` to + `docs/architecture-decisions/adr000-my-decision.md` (my-decision should be + descriptive. Do not assign an ADR number.) - Fill in the ADR following the guidelines in the template - Submit a pull request - Address and integrate feedback from the community