Conversation
|
There was a problem hiding this comment.
Pull request overview
This PR introduces the first Architecture Decision Record (ADR) to the evo-web project, documenting the team's decision to adopt ADRs as a practice for recording architectural decisions.
Changes:
- Added ADR 0001 documenting the decision to use Architecture Decision Records
- Established the ADR format based on Michael Nygard's template
agliga
left a comment
There was a problem hiding this comment.
Should add a template that we should use instead?
I don't think we need an ADR about using this ADR.
If we have a template, then we should simply follow it.
This is what we did for our internal VAT (our first ADR is saying we will be using ADRs - kinda funny I know - but it just gets it seeded with something I guess and shows the template we should be following). @agliga Would renaming it to |
|
|
||
| ## Decision | ||
|
|
||
| We will use Architecture Decision Records, in the same format as [described by Michael Nygard](http://thinkrelevance.com/blog/2011/11/15/documenting-architecture-decisions). |
There was a problem hiding this comment.
Can we include what parts of this format we are including? This linked post has some things that don't match what we have so far (like directory structure/filename and title format), and some of the "should" ideas leave room for interpretation
I think that helps. We could also do |
Description
Adds our first ADR, which is the decision to use ADRs!
Notes
Much of the what/why/how was thrashed out "offline" and this was the decision made.