Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

📝 Add ADR template #610

Merged
merged 1 commit into from
Jan 29, 2025
Merged

📝 Add ADR template #610

merged 1 commit into from
Jan 29, 2025

Conversation

sasamuku
Copy link
Member

Summary

Introduce ADR Template to store architecture decisions.

Related Issue

Changes

Testing

Other Information

@changeset-bot changeset-bot
Copy link

changeset-bot bot commented Jan 29, 2025

⚠️ No Changeset found

Latest commit: 74f0c4f

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

sasamuku
sasamuku commented Jan 29, 2025
View reviewed changes
docs/adr/template.md

---

# {YYYYMMDD}. {TITLE}
Copy link
Member Author

Choose a reason for hiding this comment

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

Incremental numbering (like 1, 2, 3, ...) will cause inconsistencies when we want to add past ADRs.
How about numbering by date?

Copy link
Member

Choose a reason for hiding this comment

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

That's great idea 🚀

@sasamuku sasamuku marked this pull request as ready for review January 29, 2025 02:15
@sasamuku sasamuku requested a review from a team as a code owner January 29, 2025 02:15
@sasamuku sasamuku requested review from hoshinotsuyoshi, FunamaYukina, junkisai and MH4GF and removed request for a team January 29, 2025 02:15
MH4GF
MH4GF approved these changes Jan 29, 2025
View reviewed changes
Copy link
Member

@MH4GF MH4GF left a comment

Choose a reason for hiding this comment

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

LGTM 👍🏻
I'd like someone else to review it.

FunamaYukina
FunamaYukina approved these changes Jan 29, 2025
View reviewed changes
Copy link
Member

@FunamaYukina FunamaYukina left a comment

Choose a reason for hiding this comment

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

This is a very useful ADR template.Thanks a lot!

@FunamaYukina FunamaYukina added this pull request to the merge queue Jan 29, 2025
Merged via the queue into main with commit ff4ec8b Jan 29, 2025
12 checks passed
@FunamaYukina FunamaYukina deleted the add_adr_template branch January 29, 2025 02:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@FunamaYukina FunamaYukina FunamaYukina approved these changes

@MH4GF MH4GF MH4GF approved these changes

@hoshinotsuyoshi hoshinotsuyoshi Awaiting requested review from hoshinotsuyoshi hoshinotsuyoshi is a code owner automatically assigned from liam-hq/liam-dev

@junkisai junkisai Awaiting requested review from junkisai junkisai is a code owner automatically assigned from liam-hq/liam-dev

Assignees

@sasamuku sasamuku

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@sasamuku @FunamaYukina @MH4GF