mirror of
https://github.com/penpot/penpot.git
synced 2026-11-10 20:10:37 +00:00
📚 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
This commit is contained in:
parent
e1f924cf00
commit
88b09efd87
@ -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`.
|
||||
|
||||
@ -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.
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user