Skip to content

Commit 8f31fa9

Browse files
committed
changeset nit
1 parent d772003 commit 8f31fa9

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

AGENTS.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -131,14 +131,14 @@ This project uses [Changesets](https://github.com/changesets/changesets) for ver
131131

132132
Changeset guidelines:
133133
- Create a changeset for any user-facing changes (features, bug fixes); typically in new pull requests;
134-
- a pull request can have multiple changesets
134+
- a pull request can have multiple changesets; separate files for separate changes
135135
- Select the appropriate semver bump: `patch` (bug fixes) or `minor` (new features)
136136
- This is a pre-1.0 preview release, so there are no `major` breaking change bumps yet
137137
- Good changesets explain:
138138
- WHAT the change is
139139
- WHY the change was made
140140
- HOW a consumer should update their code
141-
- Good changesets are brief and user-focused (not contributor); they are generally 1 line or a short paragraph for detailed changes; The content of the changeset is used in CHANGELOG and release notes.
141+
- Good changesets are brief and user-focused (not contributor); they are generally 1 line or two; The content of the changeset is used in CHANGELOG and release notes. You do not need to list internal implementation details or all details of commands; just the high level summary for users.
142142

143143
create a changeset file directly in `.changeset/` with a unique filename (e.g., `descriptive-change-name.md`):
144144

0 commit comments

Comments
 (0)