Repository navigation
⚕️:say where changelogs come from - #930
Conversation
The contribution guidelines said nothing about changelogs, so the question of whether a project should keep one stayed open, and a contributor had no way to know that the SDK already does, or that its files are generated and not written. They now say so. A project that publishes packages keeps a `CHANGELOG.md` for each, and Changesets writes it at release time from the changeset files pull requests leave in `.changeset/`. A change a package's users would notice adds one, with a summary written for them; a test, refactor, CI or documentation change does not. The section also says why the commit history is not the changelog, and that an entry is corrected in its changeset, since a hand edit to the generated file does not survive the next release. The pull request checklist gains a line pointing at the new section. Signed-off-by: Derek Lewis <DerekNonGeneric@inf.is> Assisted-by: Claude-Code:claude-opus-5 Fixes: #731
|
Navigate logical layers of code changes, visualize relationships, and explore their blast radius. No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Essentials Run ID: 📒 Files selected for processing (1)
Included review availability: This review used your included allowance. 1 included review remains after this review. Your included PR review attempts over the past 7 days set your current allowance at 5 reviews per hour. 📝 WalkthroughWalkthroughCONTRIBUTING.md now explains when package-user-visible changes need a changeset, how to create and summarize one, which changes can omit one, and how to handle changelog edits. ChangesChangeset contribution guidance
Priority: ⬇️ Low Estimated code review effort: 1 (Trivial) | ~5 minutes Change: Other Merge Risk: ⚪ Minimal · up to No material merge risk remains: user-visible package changes, including documentation, are still covered by the changeset guidance. 🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
Full details: Linked Issues checkExplanation Issue Resolution Add the requested versioned changelog content for the project or published packages. Configure or use the documented Changesets flow so future releases produce chronological entries. Add automated coverage for any new generation or validation behavior if code is introduced.
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
Requested by DerekNonGeneric
Before: CONTRIBUTING.md said nothing about changelogs, so a contributor had no way to know that packages keep one or who writes it.
After: a new Changelogs section says each published package has a
CHANGELOG.mdthat Changesets writes at release time from.changeset/files. A change users would notice adds a changeset written for them, and tests, refactors, CI and docs don't need one. The section also covers why the commit history is not the changelog and why an entry is corrected in its changeset rather than by hand. The pull request checklist links to it.How: prose only, formatted with prettier. It matches what the SDK's own CONTRIBUTING.md and RELEASING.md already do.
Fixes #731
Summary by CodeRabbit