-
Whoever makes the core architecture decision has to write up an ADR. If someone makes an adjustment to the architecture down the road, this person is responsible for updating the ADR.
-
When you are facing an issue and you need to make an architecture decision, please create a copy of the
adr_template-file and fill it out. -
The moment you are ready to make a proposal please create a Pull Request to master.
-
In the document you can set a deadline until when you need a decision.
-
Please request reviews from the people you want input. Remind them to review in slack if nothing happens.
-
Depending on the input, please go back to step 1. and build a new proposal. Best include the reviewer with the input in the new proposal.
-
If your proposal was approved, please merge the PR.
This is a template for architecture decisions based partly on Documenting architecture decisions - Michael Nygard.
In each ADR file, write these sections:
Trello-card: Add Link if relevant
Decision Deadline: Add Date
Discussion Participants: Add list of discussion partipants and list their Github profile or email. If it is a single author, use "Author" instead of "Discussion Participants".
What is the status, such as proposed, accepted, rejected, deprecated, superseded, etc.?
What is the issue that we're seeing that is motivating this decision or change?
What are the key criterias on which the decision is based.
Which alternatives were considered?
What is the change that we're proposing and/or doing?
What becomes easier or more difficult to do because of this change?