Skip to content

⚕️:say where changelogs come from - #930

Merged
openinf-commit-queue[bot] merged 1 commit into
mainfrom
claude/project-thread-1iaim0-changelog
Sep 30, 2026
Merged

openinf-commit-queue[bot] merged 1 commit into
mainfrom
claude/project-thread-1iaim0-changelog

Conversation

@DerekNonGeneric

@DerekNonGeneric DerekNonGeneric commented Sep 26, 2026 •

Copy link
Copy Markdown
Member

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

  • Documentation
    • Added contributor guidance on when and how to write changesets, including what to include in summaries and how they relate to package changelogs.

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
@DerekNonGeneric DerekNonGeneric self-assigned this Sep 26, 2026
@coderabbitai

coderabbitai Bot commented Sep 26, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

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 configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Essentials

Run ID: 20db121f-6644-4d54-96ec-885b42f95379

📥 Commits

Reviewing files that changed from the base of the PR and between 5ab1b14 and 09413fc.

📒 Files selected for processing (1)
  • CONTRIBUTING.md

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.


📝 Walkthrough

Walkthrough

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

Changes

Changeset contribution guidance

Layer / File(s) Summary
Document changeset requirements
CONTRIBUTING.md
The guide explains when to add a changeset, how to create one with pnpm exec changeset, what its summary should cover, which changes do not need one, and that changelog edits should use changeset files. It also adds a Changesets link definition.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to 09413

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)

Check name Status Explanation Resolution
Linked Issues check ⚠️ Warning Issue #731 requests a curated, chronological changelog of notable changes for each project version. This pull request adds contributor guidance for future Changesets, but it adds no CHANGELOG.md, `.… 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 validati…
✅ Passed checks (4 passed)
Check name Status Explanation
Out of Scope Changes check ✅ Passed The changes only modify CONTRIBUTING.md. The new checklist item, Changesets instructions, summary guidance, and link definition directly support issue #731 by documenting how contributors provide ch…
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly describes the main change: documenting where package changelogs come from.
Full details: Linked Issues check

Explanation

Issue #731 requests a curated, chronological changelog of notable changes for each project version. This pull request adds contributor guidance for future Changesets, but it adds no CHANGELOG.md, .changeset/ entry, generated release entry, or other versioned changelog content. The repository file list at the reviewed head also contains no changelog file. The documentation therefore does not implement the requested changelog.

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.

  • Fix all pre-merge checks with AI
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR

Comment @coderabbitai help to get the list of available commands.

@DerekNonGeneric DerekNonGeneric added the 🚀 Status: Commit Queue Land this pull request when its checks pass label Sep 30, 2026 — with Claude
@openinf-commit-queue
openinf-commit-queue Bot merged commit ba16086 into main Sep 30, 2026
12 checks passed
@openinf-commit-queue openinf-commit-queue Bot removed the 🚀 Status: Commit Queue Land this pull request when its checks pass label Sep 30, 2026
@openinf-commit-queue
openinf-commit-queue Bot deleted the claude/project-thread-1iaim0-changelog branch September 30, 2026 22:48
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.

✨ CHANGELOG

1 participant