Skip to content

docs: added writing changeset docs#5440

Merged
nikkimk merged 7 commits intomainfrom
nikkimk/changeset-docs
May 6, 2025
Merged

docs: added writing changeset docs#5440
nikkimk merged 7 commits intomainfrom
nikkimk/changeset-docs

Conversation

@nikkimk
Copy link
Copy Markdown
Contributor

@nikkimk nikkimk commented May 6, 2025

Description

  • Added writing-changesets.md to our Guides.
  • Linked to writing-changesets.md from .changesets/README.md.
  • Linked to writing-changesets.md from ./README.md.

Motivation and context

We need to provide guidance for writing good changesets. We should make the distinction between commits and changesets clear: Commits are for a contributor audience. Changesets are for a consumer audience.

Related issue(s)

  • resolves SWC-826

Screenshots (if appropriate)


Author's checklist

  • I have read the CONTRIBUTING and PULL_REQUESTS documents.
  • I have reviewed at the Accessibility Practices for this feature, see: Aria Practices
  • I have added automated tests to cover my changes. (N/A this is a docs PR)
  • I have included a well-written changeset if my change needs to be published.
  • I have included updated documentation if my change required it.

Reviewer's checklist

  • Includes a Github Issue with appropriate flag or Jira ticket number without a link
  • Includes thoughtfully written changeset if changes suggested include patch, minor, or major features (N/A this is a docs PR)
  • Automated tests cover all use cases and follow best practices for writing (N/A this is a docs PR)
  • Validated on all supported browsers
  • All VRTs are approved before author can update Golden Hash

Manual review test cases

Device review

  • Did it pass in Desktop?
  • Did it pass in (emulated) Mobile?
  • Did it pass in (emulated) iPad?

@changeset-bot
Copy link
Copy Markdown

changeset-bot Bot commented May 6, 2025

⚠️ No Changeset found

Latest commit: 9f2e58c

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
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 6, 2025

Branch preview

Review the following VRT differences

When a visual regression test fails (or has previously failed while working on this branch), its results can be found in the following URLs:

If the changes are expected, update the current_golden_images_cache hash in the circleci config to accept the new images. Instructions are included in that file.
If the changes are unexpected, you can investigate the cause of the differences and update the code accordingly.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented May 6, 2025

Tachometer results

Currently, no packages are changed by this PR...

@nikkimk nikkimk marked this pull request as ready for review May 6, 2025 16:49
@nikkimk nikkimk requested a review from a team as a code owner May 6, 2025 16:49
Copy link
Copy Markdown
Contributor

@blunteshwar blunteshwar left a comment

Choose a reason for hiding this comment

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

This looks great!

@caseyisonit caseyisonit added the Status:Ready for review PR ready for review or re-review. label May 6, 2025
@nikkimk nikkimk merged commit ee99d08 into main May 6, 2025
24 checks passed
@nikkimk nikkimk deleted the nikkimk/changeset-docs branch May 6, 2025 22:02
castastrophe pushed a commit that referenced this pull request May 9, 2025
* docs: init changeset docs

* docs: updated changeset docs

* docs: changed title

* docs: updated link text
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Status:Ready for review PR ready for review or re-review.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants