Skip to content

Commit c3899e8

Browse files
committed
internal: Add changeset instructions
1 parent a4092a1 commit c3899e8

File tree

2 files changed

+25
-0
lines changed

2 files changed

+25
-0
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,14 @@ If your idea requires design considerations, it's best to [start a discussion][4
3434
* Add tests for your feature. You should be able to look at other tests for
3535
examples. If you're unsure, don't hesitate to [open an issue][1] and ask!
3636

37+
* Add a changeset for user-facing changes in published packages:
38+
* Run `yarn changeset` from repo root (run it once per distinct change).
39+
* Write **terse changelog text** (1–3 short lines); include only **minimal examples** if needed.
40+
* For **breaking changes**, include a minimal migration example with:
41+
* `#### before`
42+
* `#### after`
43+
* If multiple packages are affected in different ways, generate **separate changesets** for each respective change.
44+
3745
* Submit your pull request!
3846

3947
## Support Requests
Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
alwaysApply: true
3+
---
4+
5+
## Changesets (release notes)
6+
7+
- **When to add**: Any user-facing change in a published package (`packages/*`) should include a changeset.
8+
- **Command**: Run `yarn changeset` from repo root (run it once per distinct change).
9+
- **Terse changelog text**:
10+
- **Keep it short**: 1–3 short lines describing the outcome (not implementation details).
11+
- **Minimal examples only**: If an example helps, prefer a tiny snippet (typically import + 1 call). Avoid long blocks.
12+
- **Breaking changes**: Include a tiny migration example using:
13+
- `#### before`
14+
- `#### after`
15+
- **Split changesets by impact**:
16+
- If **multiple packages are affected in different ways**, create **separate changesets** so each package’s changelog is focused.
17+
- If the same change applies uniformly to multiple packages, a single changeset is fine.

0 commit comments

Comments
 (0)