Skip to content

Latest commit

 

History

History
63 lines (39 loc) · 1.88 KB

0000-ADR-template.md

File metadata and controls

63 lines (39 loc) · 1.88 KB

ADR Process

yyyy-mm-dd

Summary of the intent/context for the ADR. What was the problem solved?

Authors

@...

Status

N/A

Alternatives Considered

  • Make an ADR template in the repo
  • Send an email describing how to make an ADR to everyone
  • Make an ADR template in Google Docs
  • ...

Decision Outcome

Made a template within the docs/ADRs repo directory. It was based on the Truss (DU project) ADRs 1

Consequences

Adds a file to the repo, but allows easy discovery. Makes updating the template straightforward if needed. However, this may need to be revisited if multiple repos are create for the project, as that might require duplicating the template, or changing where ADRs are stored.

Pros and Cons of the Alternatives

Make an ADR template

  • + Discoverable
  • - Only exists in one repo, might be hard to use if more repos are created for the project.

Send an email describing how to make an ADR to everyone

  • + Everyone is notified
  • - Not discoverable after initial email
  • - Hard to update easily, might lose track of who to email
  • - Silly

Send an email describing how to make an ADR to everyone

  • + May work better if there are many repos related to the project
  • - Not particularly discoverable

References

Footnotes

  1. DU Project ADR Example ↩