How to write an ADR?
Great! You've decided to write an ADR. This process will likely improve in the future, but here are the recommended steps for now:
- Add a new ADR file to this folder (
.md
format) - Use the following name:
{{timestamp}}-short-decision-summary.md
- Grab the
timestamp
from this page - Use the template below for writing an ADR
- Keep it short and sweet; ADRs are meant to be brief and easy to digest. Check out the other ADRs for inspiration!
- Open a PR and ask for feedback. Tag the people familiar with the specific area to verify that your decision record correctly captures the decision made.
ADR template
{{date}} ### Context ### Decision ### Consequences