Skip to content

Commit

Permalink
Date based adr number
Browse files Browse the repository at this point in the history
  • Loading branch information
brendankowitz committed Jan 29, 2025
1 parent dbaacfe commit c6ac592
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/arch/Readme.md
Original file line number Diff line number Diff line change
@@ -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>-<short-title>.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-<yymmdd>-<short-title>.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:

Expand Down

0 comments on commit c6ac592

Please sign in to comment.