Skip to content

Improve adr-000-template.md #5957

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.

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

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Improve adr-000-template.md #5957

wants to merge 6 commits into from

Conversation

lesliecdubs
Copy link
Member

Changelog

Improves the project's ADR template with additional sections and better formatting, in alignment with https://github.com/github/primer/pull/5111 (GitHub staff only)

Changed

Improved content and formatting in the ADR template

Rollout strategy

  • Patch release
  • Minor release
  • Major release; if selected, include a written rollout or migration plan
  • None; if selected, include a brief description as to why - change is related to documentation only

Testing & Reviewing

Review the diff

Merge checklist

@lesliecdubs lesliecdubs self-assigned this Apr 23, 2025
@Copilot Copilot AI review requested due to automatic review settings April 23, 2025 01:20
@lesliecdubs lesliecdubs requested a review from a team as a code owner April 23, 2025 01:20
@lesliecdubs lesliecdubs requested a review from hectahertz April 23, 2025 01:20
Copy link

changeset-bot bot commented Apr 23, 2025

⚠️ No Changeset found

Latest commit: 5aa57f3

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

@github-actions github-actions bot added the staff Author is a staff member label Apr 23, 2025
Copy link
Contributor

@Copilot 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 refines the project's ADR template to enhance its clarity and usability.

  • Updated the title header and added a date field.
  • Replaced the table in the Status section with inline guidance and added an Implementation descriptor.
  • Introduced Consequences and Alternatives sections to provide additional decision context.

@lesliecdubs lesliecdubs added the skip changeset This change does not need a changelog label Apr 23, 2025
Copy link
Contributor

github-actions bot commented Apr 23, 2025

size-limit report 📦

Path Size
packages/react/dist/browser.esm.js 102.58 KB (0%)
packages/react/dist/browser.umd.js 102.84 KB (0%)

@github-actions github-actions bot requested a deployment to storybook-preview-5957 April 23, 2025 01:29 Abandoned
@github-actions github-actions bot requested a deployment to storybook-preview-5957 April 23, 2025 01:36 Abandoned
@github-actions github-actions bot requested a deployment to storybook-preview-5957 April 23, 2025 01:49 Abandoned
@github-actions github-actions bot requested a deployment to storybook-preview-5957 April 23, 2025 01:53 Abandoned
@lesliecdubs
Copy link
Member Author

@hectahertz I see the "stress tests" job is failing, although I can't imagine anything in this PR was the cause. Could you please take a look and advise?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip changeset This change does not need a changelog staff Author is a staff member
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants