From 45b0f2339b817830ba68d100618772b4de16a8c9 Mon Sep 17 00:00:00 2001 From: DavHau Date: Tue, 4 Feb 2025 10:41:26 +0700 Subject: [PATCH] add /decisions see https://github.com/joelparkerhenderson/architecture-decision-record --- decisions/README.md | 1 + decisions/_template.md | 24 ++++++++++++++++++++++++ 2 files changed, 25 insertions(+) create mode 100644 decisions/README.md create mode 100644 decisions/_template.md diff --git a/decisions/README.md b/decisions/README.md new file mode 100644 index 000000000..68ef5a443 --- /dev/null +++ b/decisions/README.md @@ -0,0 +1 @@ +see [architecture-decision-record](https://github.com/joelparkerhenderson/architecture-decision-record) diff --git a/decisions/_template.md b/decisions/_template.md new file mode 100644 index 000000000..c17fe0272 --- /dev/null +++ b/decisions/_template.md @@ -0,0 +1,24 @@ +# Decision record template by Michael Nygard + +This is the template in [Documenting architecture decisions - Michael Nygard](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions). +You can use [adr-tools](https://github.com/npryce/adr-tools) for managing the ADR files. + +In each ADR file, write these sections: + +# Title + +## Status + +What is the status, such as proposed, accepted, rejected, deprecated, superseded, etc.? + +## Context + +What is the issue that we're seeing that is motivating this decision or change? + +## Decision + +What is the change that we're proposing and/or doing? + +## Consequences + +What becomes easier or more difficult to do because of this change?