diff --git a/.rladr b/.rladr new file mode 100644 index 0000000000..37ed33a36c --- /dev/null +++ b/.rladr @@ -0,0 +1 @@ +adr \ No newline at end of file diff --git a/Gemfile b/Gemfile index 578ecf719d..1e59d7dc1e 100644 --- a/Gemfile +++ b/Gemfile @@ -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" diff --git a/Gemfile.lock b/Gemfile.lock index 894d5e8629..2dc199a2ec 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -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) @@ -223,6 +224,7 @@ DEPENDENCIES importmap-rails puma (~> 5.0) rails (~> 7.0.3) + rladr rspec rspec-rails sprockets-rails diff --git a/README.md b/README.md index 0b37dd7d57..aff18d3d8e 100644 --- a/README.md +++ b/README.md @@ -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 use `rladr` to generate the boilerplate for new records: - - - - - +```bash +bin/bundle exec rladr new title +``` ## Setup diff --git a/adr/00001-record-architecture-decisions.md b/adr/00001-record-architecture-decisions.md new file mode 100644 index 0000000000..5deb6e8692 --- /dev/null +++ b/adr/00001-record-architecture-decisions.md @@ -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).