diff --git a/.copier-answers.yml b/.copier-answers.yml index e08d2a7..b38dbd1 100644 --- a/.copier-answers.yml +++ b/.copier-answers.yml @@ -1,5 +1,5 @@ # Changes here will be overwritten by Copier -_commit: 1.1.0-2-gc52aaa1 +_commit: 1.1.0-4-g871b14d _src_path: gh:DiamondLightSource/python-copier-template author_email: tom.cobb@diamond.ac.uk author_name: Tom Cobb diff --git a/docs/explanations/decisions.md b/docs/explanations/decisions.md index f97c2f9..0533b98 100644 --- a/docs/explanations/decisions.md +++ b/docs/explanations/decisions.md @@ -1,14 +1,6 @@ -% This Source Code Form is subject to the terms of the Mozilla Public - -% License, v. 2.0. If a copy of the MPL was not distributed with this - -% file, You can obtain one at http://mozilla.org/MPL/2.0/. - # Architectural Decision Records -We record major architectural decisions in Architecture Decision Records (ADRs), -as [described by Michael Nygard](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions). -Below is the list of our current ADRs. +Architectural decisions are made throughout a project's lifetime. As a way of keeping track of these decisions, we record these decisions in Architecture Decision Records (ADRs) listed below. ```{toctree} :glob: true @@ -16,3 +8,5 @@ Below is the list of our current ADRs. decisions/* ``` + +For more information on ADRs see this [blog by Michael Nygard](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions). diff --git a/docs/explanations/decisions/COPYME b/docs/explanations/decisions/COPYME new file mode 100644 index 0000000..b466c79 --- /dev/null +++ b/docs/explanations/decisions/COPYME @@ -0,0 +1,19 @@ +# 3. Short descriptive title + +Date: Today's date + +## Status + +Accepted + +## Context + +Background to allow us to make the decision, to show how we arrived at our conclusions. + +## Decision + +What decision we made. + +## Consequences + +What we will do as a result of this decision.