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 guidance for package maintenance #113

Open
desi opened this issue Nov 7, 2024 · 0 comments
Open

Add guidance for package maintenance #113

desi opened this issue Nov 7, 2024 · 0 comments

Comments

@desi
Copy link
Contributor

desi commented Nov 7, 2024

Cover topics like:

  • Use the module template
  • Follow SemVer
  • Changelog maintenance
  • Testing prerelease builds locally and on CI
    • e.g. yarn link or file:// for local, preview builds for CI
  • dependencies vs peerDependencies vs devDependencies

Notes:
This message was on Slack and should be included in the guidelines in some way:
PSA: There are two primary ways that we communicate changes we've make to our NPM packages to consumers. Changelogs are one of them, but we also use versions as a coarse indicator as well. I have seen several instances over time where a version for a released package was bumped in a way that either oversells or undersells the changes inside of that release. For instance:

  • Bumping the minor part of a version if new functionality was not being added, when only the patch should have been bumped
  • Bumping only the patch part of a version when new functionality was added, when the minor should have been bumped
  • Not bumping the major part of a version when breaking changes are introduced

As a reminder, we use SemVer to assign new versions for packages. I would recommend everyone read this when they get a chance, especially the "Why Use" section and the FAQ.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants