mediawiki-extensions-Popups/docs/adr/0001-record-architecture-decisions.md

# 1. Record architecture decisions

Date: 2016-11-09

## Status

Accepted

## Context

We need to record the architectural decisions made on this project.

## Decision

We will use Architecture Decision Records, as described by Michael Nygard in
[this article](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions).

## Consequences

See Michael Nygard's article, linked above.
Use Architecture Decision Records Changes: * Add an ADR for using ADRs (added by `adr init`). * Add an ADR for containing and managing state. Change-Id: I12478ea7154c4f21204630cebdbfa18b8c0d6ba6 2016-11-09 11:02:57 +00:00			`# 1. Record architecture decisions`

Prefer YYYY-MM-DD ISO dates in all documentation It is probably not that critical to understand if "09/11/2016" refers to September 11th or November 9th. I still think it's worth looking for a documentation format that is easy to understand by an international developers community. My personal best practice is to use the ISO format. Change-Id: Ib209a8a1651970d74f82c188ae4b84d1a4eb534e 2019-01-17 16:06:44 +00:00			`Date: 2016-11-09`
Use Architecture Decision Records Changes: * Add an ADR for using ADRs (added by `adr init`). * Add an ADR for containing and managing state. Change-Id: I12478ea7154c4f21204630cebdbfa18b8c0d6ba6 2016-11-09 11:02:57 +00:00
			`## Status`

			`Accepted`

			`## Context`

			`We need to record the architectural decisions made on this project.`

			`## Decision`

			`We will use Architecture Decision Records, as described by Michael Nygard in`
			`[this article](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions).`

			`## Consequences`

			`See Michael Nygard's article, linked above.`