Skip to content

docs: Added first ADR#474

Open
ianmcburnie wants to merge 1 commit intomainfrom
adrs
Open

docs: Added first ADR#474
ianmcburnie wants to merge 1 commit intomainfrom
adrs

Conversation

@ianmcburnie
Copy link
Contributor

@ianmcburnie ianmcburnie commented Jan 28, 2026

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.

Copilot AI review requested due to automatic review settings January 28, 2026 18:14
@changeset-bot
Copy link

changeset-bot bot commented Jan 28, 2026

⚠️ No Changeset found

Latest commit: 356d947

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Collaborator

@agliga agliga left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@ianmcburnie
Copy link
Contributor Author

ianmcburnie commented Feb 5, 2026

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 0001-decision-format.md work? If this decision changes, all new adrs from that time forward would adopt the new format.


## 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).
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

@ArtBlue
Copy link
Contributor

ArtBlue commented Feb 6, 2026

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 0001-decision-format.md work? If this decision changes, all new adrs from that time forward would adopt the new format.

I think that helps. We could also do 0000-adr-template to be more explicit. Just a thought as it removes all ambiguity.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants