Example of Architectural Decision Records
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
doc/adr
.gitignore
LICENSE
README.md

README.md

ADR Example

Installing ARD Tools

See here

Getting started

Initialise project

adr init

This will initialise the repo and create a doc/adr directory (you can override this) with the first ADR explaining that we will be recording ADRs in this repo :)

Add an ADR

adr new Use JUnit 4.12 for testing

This adds a new ADR (automatically numbered as number 0002) that records our decision to use JUnit 4.12

Supersede an ADR

adr new -s 2 Use JUnit 5 for testing

This creates an additional ADR that supersedes the old one (number 2). Both ADRs refer to each other.