From 88b09efd87510b488601f4ee03319fb9ff086ff0 Mon Sep 17 00:00:00 2001 From: Andrey Antukh Date: Tue, 10 Nov 2026 16:58:21 +0000 Subject: [PATCH] :books: Note breaking changes must not be hard-wrapped The changelog generator copies the note lines verbatim, so a note hard-wrapped at 80 columns ends up wrapped in CHANGES.md. Record that the breaking-change note must keep one line per paragraph or bullet, in both the issue and changelog workflow memories. AI-assisted-by: inkling-2-small-free --- .serena/memories/workflow/creating-issues.md | 1 + .serena/memories/workflow/updating-changelog.md | 1 + 2 files changed, 2 insertions(+) diff --git a/.serena/memories/workflow/creating-issues.md b/.serena/memories/workflow/creating-issues.md index 4c8374aa31..2275cc9d8d 100644 --- a/.serena/memories/workflow/creating-issues.md +++ b/.serena/memories/workflow/creating-issues.md @@ -60,6 +60,7 @@ the issue (`scripts/changelog.py boom`), so the issue must carry both: Post the note as a new comment. Do not add a breaking-change section to the issue body and do not hand-write the changelog block. When the issue comes from a PR, reuse the text of the PR's breaking-change section. +Do not hard-wrap the note: one line per paragraph or bullet. The full changelog rules (sections, exclusions, `:rocket:`, pre-flight and anomaly report) live in `mem:workflow/updating-changelog`. diff --git a/.serena/memories/workflow/updating-changelog.md b/.serena/memories/workflow/updating-changelog.md index 26ac7624af..bcc2b75664 100644 --- a/.serena/memories/workflow/updating-changelog.md +++ b/.serena/memories/workflow/updating-changelog.md @@ -116,6 +116,7 @@ Rules for the note: - **Write it for admins**: what changes, what they must do, and what breaks if they do nothing. Do not paste the full runbook; explain the implications and link the runbook or docs. - **Link a long-lived branch**, `staging` or `main`, never a feature branch (`issue-1234`). The link may 404 until the PR merges; that is expected. - **Do not add issue or PR links**: the generator appends them. +- **Do not hard-wrap the text**: one line per paragraph or bullet. The generator copies lines verbatim, so wrapped lines end up wrapped in `CHANGES.md`. - **One note per issue**. If several comments carry the marker, the generator uses the last one and warns. - **No note**: the generator warns on stderr and emits only the heading and references; fix the issue, not `CHANGES.md`. - **`####`, not `###`**: `###` is the level of the changelog sections. An entry at `###` would render as a sibling section and the scripts that read and rewrite `:boom:` would cut the section there. The note author never writes the `####`: the generator adds it.