Skip to content

docs(swift): write changesets in the past tense #156

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tmm merged 1 commit into from
Nov 14, 2026
Merged

docs(swift): write changesets in the past tense #156

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions swift/.changeset/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
3 changes: 2 additions & 1 deletion swift/AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
Loading