Skip to content

Keep the Changed changelog section for changes that users may have to act on - #20728

Merged
RobinMalfait merged 3 commits into
mainfrom
robin/open-pr-changelog-sections
Nov 16, 2026
Merged

RobinMalfait merged 3 commits into
mainfrom
robin/open-pr-changelog-sections

Conversation

@RobinMalfait

@RobinMalfait RobinMalfait commented Nov 16, 2026 •

Copy link
Copy Markdown
Contributor

This PR keeps ### Changed in the changelog for changes that users may have to act on, and documents which section to use.

[Unreleased] had a ### Changed section with two performance entries (#20680 and #20688). A performance improvement is not a change that users have to act on, and the repo already lists them under ### Fixed (e.g. #20694, #20678 and #20663).

Changes

This PR edits CHANGELOG.md directly instead of adding a fragment, because it fixes entries that the "Compile changelog" workflow already compiled. Released sections stay as they are. The PR changes only docs, so it needs no changelog entry of its own.

Test plan

  • pnpm changelog check passes.
  • pnpm --silent changelog shows [Unreleased] with only ### Fixed.
  • pnpm prettier --check passes for the three files.

The Changed section is meant for changes that users may have to act on.
The two entries of #20680 and #20688 describe one performance
improvement, so combine them into one entry in Fixed, like the other
performance entries.
@RobinMalfait
RobinMalfait requested a review from a team as a code owner November 16, 2026 21:54
@RobinMalfait RobinMalfait self-assigned this Nov 16, 2026
@greptile-apps

greptile-apps Bot commented Nov 16, 2026 •

Copy link
Copy Markdown
Contributor

RetriggerView in GreptileConfidence Score: 5/5

[Low impact] The documentation changes appear safe to merge.

Reviews (3) · Last reviewed commit: "Move the canonicalization entry of [Unre..." · Reviewed by Greptile

A canonicalization improvement is not a new feature for users, like the
canonicalization entries of 4.3.4 and 4.3.5 in Fixed. Update the guide
in CONTRIBUTING.md to match.
@coderabbitai

coderabbitai Bot commented Nov 16, 2026 •

Copy link
Copy Markdown
Contributor

Explain Change →

No actionable comments were generated in the recent review.

Walkthrough

The changelog instructions now link to contributor guidance for selecting a section. The guidance adds classification criteria and examples, including that performance improvements belong under ### Fixed, not ### Changed. The Unreleased changelog combines rebuild-performance notes under fixes and removes the separate changed entries.

Merge Risk: Minimal · up to b2b5c

This change updates changelog guidance and Unreleased entries only. It does not alter runtime behavior, and there is no identified merge-blocking risk.

Pre-merge checks: Passed 4

Check name Status Explanation
Title check Passed The title states the main change: the PR keeps the Changed changelog section for changes users may have to act on. The changeset matches this. It removes the Changed section from Unreleased, and it ad…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Description check Passed The description states the PR keeps the Changed section for user-actionable changes, removes the Changed section from Unreleased, moves performance and canonicalization entries under Fixed, and adds a…
Full details: Title check

Explanation

The title states the main change: the PR keeps the Changed changelog section for changes users may have to act on. The changeset matches this. It removes the Changed section from Unreleased, and it adds guidance in CONTRIBUTING.md on choosing a section. The title covers the core policy, but not the removal of the performance entries or the guide itself.

Full details: Description check

Explanation

The description states the PR keeps the Changed section for user-actionable changes, removes the Changed section from Unreleased, moves performance and canonicalization entries under Fixed, and adds a contributor guide linked from the changelog README. It matches the changeset in CHANGELOG.md, .github/CONTRIBUTING.md, and .changelog/README.md, so it is on topic and specific.

  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

Recent review info

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Repository UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 18a65468-6b44-4c02-9563-8313ce461fb5
Commits

Reviewing files that changed from the base of the PR and between 4335a5f and b2b5c9d.

Files selected for processing: 2

  • .github/CONTRIBUTING.md
  • CHANGELOG.md
Files skipped from review as they are similar to previous changes: 1

  • CHANGELOG.md

Included review availability: This review used your included allowance. Your plan provides up to 10 included reviews per hour; 6 remain after this review.

@RobinMalfait
RobinMalfait merged commit ae63833 into main Nov 16, 2026
13 checks passed
@RobinMalfait
RobinMalfait deleted the robin/open-pr-changelog-sections branch November 16, 2026 22:10
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.

1 participant