From a961bd34b589a6aa8cbad92bab82e1a2424a27a2 Mon Sep 17 00:00:00 2001 From: Amp Date: Sat, 14 Nov 2026 17:36:55 +0000 Subject: [PATCH] docs(swift): write changesets in the past tense MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Changesets for lexical-swift were written in the present tense ("`LexicalList` keeps …"). At tmm's request they are now written in the past tense, starting with what was done ("Added …", "Changed …", "Fixed …", "Removed …"). swift/.changeset/README.md states the rule and its example follows it, and swift/AGENTS.md's Changesets section repeats it. Released CHANGELOG.md sections are not rewritten. Docs only, so no changeset. Checked with `npx prettier --check swift/.changeset/README.md swift/AGENTS.md` (all matched files use Prettier code style). README.md is excluded from the changesets that swift/scripts/version-packages.sh and swift-release.yml consume, so this opens no version PR. Amp-Thread-ID: https://ampcode.com/threads/T-01a19fce-8f8f-751a-afa3-961a37bb1a98 --- swift/.changeset/README.md | 6 ++++-- swift/AGENTS.md | 3 ++- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/swift/.changeset/README.md b/swift/.changeset/README.md index 220c62f7414..d4ae11b8b2b 100644 --- a/swift/.changeset/README.md +++ b/swift/.changeset/README.md @@ -15,14 +15,16 @@ belongs to upstream Lexical's npm packages): 'lexical-swift': patch --- -`LexicalList` keeps a check item's state when it is split. +Fixed `LexicalList` losing a check item's state when the item was split. ``` - `patch` for fixes and additions, `minor` for a break (an app that built against the last release no longer compiles, or a behavior it relied on changes) while the package is below 1.0, and `major` only from 1.0. - The body is the changelog entry: written for someone who uses the - package, in the present tense. A break says what to change. + package, in the past tense, starting with what was done ("Added …", + "Changed …", "Fixed …", "Removed …"). A break says what to change. + Sections of `CHANGELOG.md` already released stay as they were written. `swift/scripts/api-breaks.sh` fails CI on a public API break since the last release unless a pending changeset bumps by a `minor` (below 1.0) or more. diff --git a/swift/AGENTS.md b/swift/AGENTS.md index e88facc3713..2da23d4abdf 100644 --- a/swift/AGENTS.md +++ b/swift/AGENTS.md @@ -75,7 +75,8 @@ UI changes also run on macOS and the iOS Simulator. A user-facing change to the package (API, behavior, types, platforms) adds a changeset in `swift/.changeset/` in the same pull request; its README has -the format. A break needs a `minor` changeset below 1.0. Tests, the +the format. Write its body in the past tense ("Added …", "Changed …", +"Fixed …"). A break needs a `minor` changeset below 1.0. Tests, the playground, examples and CI need none. Don't edit `swift/CHANGELOG.md` or `swift/VERSION` by hand.