Skip to content

Commit

Permalink
Add ADRs using the template
Browse files Browse the repository at this point in the history
  • Loading branch information
tvararu committed May 10, 2022
1 parent e5cf06d commit 40faf75
Show file tree
Hide file tree
Showing 5 changed files with 30 additions and 8 deletions.
1 change: 1 addition & 0 deletions .rladr
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
adr
1 change: 1 addition & 0 deletions Gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ group :development, :test do
end

group :development do
gem 'rladr'
# Use console on exceptions pages [https://github.com/rails/web-console]
gem "web-console"

Expand Down
2 changes: 2 additions & 0 deletions Gemfile.lock
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,7 @@ GEM
rake (13.0.6)
reline (0.3.1)
io-console (~> 0.5)
rladr (1.2.0)
rspec (3.11.0)
rspec-core (~> 3.11.0)
rspec-expectations (~> 3.11.0)
Expand Down Expand Up @@ -223,6 +224,7 @@ DEPENDENCIES
importmap-rails
puma (~> 5.0)
rails (~> 7.0.3)
rladr
rspec
rspec-rails
sprockets-rails
Expand Down
14 changes: 6 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,16 +14,14 @@ A service that allows teachers to apply for QTS (Qualified Teacher Status).
Apply for qualified teacher status is a monolithic Rails app built with the
GOVUK Design System and hosted on GOVUK PaaS.

TODO: ADRs
We keep track of architecture decisions in [Architecture Decision Records
(ADRs)](/adr/).

<!-- We keep track of architecture decisions in [Architecture Decision Records -->
<!-- (ADRs)](/adr/). -->
We use `rladr` to generate the boilerplate for new records:

<!-- We use `rladr` to generate the boilerplate for new records: -->

<!-- ```bash -->
<!-- bin/bundle exec rladr new title -->
<!-- ``` -->
```bash
bin/bundle exec rladr new title
```

## Setup

Expand Down
20 changes: 20 additions & 0 deletions adr/00001-record-architecture-decisions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# 1. Record architecture decisions

Date: 2022-05-10

## 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](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions).

## Consequences

See Michael Nygard's article, linked above. For a lightweight ADR toolset, see Nat Pryce's [adr-tools](https://github.com/npryce/adr-tools).

0 comments on commit 40faf75

Please sign in to comment.