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.

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

Add root CHANGELOG.md for guidance #2227

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Conversation

benjie
Copy link
Contributor

@benjie benjie commented May 3, 2024

Description

I wanted to know what caused the semver major changes in @envelop/core so I looked through the root folder for changelog/release notes; looked at the releases tab on the side (which wasn't particularly helpful) and searched the website, but to no avail. Just as I was about to give up, a thought struck me: "it's a monorepo!", and sure enough, changelogs are available for each package.

This file will hopefully help other people that also didn't think to look in folders.

Type of change

New repo documentation file.

Checklist:

  • I have followed the
    CONTRIBUTING doc and the
    style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented on my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

Further comments

At least I figured this out before DM-ing you! ❤️

Copy link

changeset-bot bot commented May 3, 2024

⚠️ No Changeset found

Latest commit: 9ef2743

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

@EmrysMyrddin
Copy link
Collaborator

By the way, I don't know what happened to the documentation, but the migration guide from v3 to v4 is actually the migration guide from v4 to v5...

Copy link
Collaborator

@EmrysMyrddin EmrysMyrddin left a comment

Choose a reason for hiding this comment

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

Can you run prettier ? Otherwise LGTM :-)

@EmrysMyrddin
Copy link
Collaborator

Perhaps we could even make a symlink to the core plugin ?

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.

None yet

2 participants