Require single-line plain-text changeset summaries - #1411
Merged
Merged
Conversation
knope renders a one-line changeset summary as a changelog bullet, but promotes anything longer to a `####` heading with the remainder stranded below it as loose body text. The release page ends up as a mix of the two. A hard line wrap is enough to trigger it on its own — the changeset for #1406 was plain text wrapped at 80 columns and still rendered as `#### Add agent guidance for detecting and preventing memory-lifecycle regressions in` — but Markdown blocks (tables, bullet lists, bold-led paragraphs) guarantee it, and those keep showing up in agent-written changesets. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
🔍 Devin Review: 1 flag
Not posted on this PR by your GitHub settings — view it in Devin Review. (Configure)
alan-george-lk
approved these changes
Sep 8, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The release page formatting is inconsistient - some entries are changelog bullets, others are
####headings followed by further markdown.That is knope's rendering rule, not a knope bug. A changeset whose summary is one line becomes a bullet:
A summary spanning more than one line is promoted to a heading, with everything after the first line dropped below it as loose body text:
Markdown blocks (tables, bullet lists, bold-led paragraphs) guarantee this, and they keep showing up in agent-written changesets — but a plain hard line wrap is enough on its own. The changeset for #1406 was plain text wrapped at 80 columns and still rendered as
#### Add agent guidance for detecting and preventing memory-lifecycle regressions in.So this adds a rule under Documenting changes in
AGENTS.md: write the changeset summary as a single unwrapped line of plain prose, no Markdown blocks (inline backticks are fine — they render correctly), and keep detail in the PR description instead.