From c6ac592b7db5d7bbff7bb20eb47e377b61b46a8c Mon Sep 17 00:00:00 2001 From: Brendan Kowitz Date: Tue, 28 Jan 2025 16:21:13 -0800 Subject: [PATCH] Date based adr number --- docs/arch/Readme.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/arch/Readme.md b/docs/arch/Readme.md index 5c58bb3271..3162149046 100644 --- a/docs/arch/Readme.md +++ b/docs/arch/Readme.md @@ -1,8 +1,8 @@ # Architecture Decision Records -We will maintain Architecture Decision Records (ADRs) in our FHIR Server repository, placing each one under `doc/arch/adr-<000>-.md`. We have chosen to write these records using Markdown. +We will maintain Architecture Decision Records (ADRs) in our FHIR Server repository, placing each one under `doc/arch/adr--.md`. We have chosen to write these records using Markdown. -Each ADR will be assigned a unique, sequential number that will never be reused. If a decision is later reversed, changed or evolved, the original record will remain in place but will be marked as superseded. Even though it’s no longer valid, it is still historically important. +Each ADR will be assigned a unique, sequential number (date based as above) that will never be reused. If a decision is later reversed, changed or evolved, the original record will remain in place but will be marked as superseded. Even though it’s no longer valid, it is still historically important. We will keep the ADR structure simple, with just a few sections in this example template: