Add root CHANGELOG.md for guidance

benjie commented 2 months ago

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
[x] I have made corresponding changes to the documentation
[x] 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! :heart:

changeset-bot[bot] commented 2 months ago

⚠️ No Changeset found

Latest commit: 83221f658cf0cda4b4635fb292be66c4cc941d56

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 commented 1 month ago

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...

EmrysMyrddin commented 1 month ago

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

benjie commented 1 month ago

Prettier executed!

n1ru4l / envelop