Skip to content

Commit 602c667

Browse files
authored
doc(contributing): Document changeset (#9667)
Requested from #9666 (comment)
1 parent aec0e40 commit 602c667

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

CONTRIBUTING.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -156,6 +156,21 @@ passes of review and changes.
156156
Once the reviewer approves your pull request, a friendly bot picks it up
157157
and merges it into the SWC `main` branch.
158158
159+
SWC uses changeset for changelog management with a bit of custom logic.
160+
A changeset for SWC looks like this:
161+
162+
```markdown
163+
---
164+
swc_core: patch
165+
swc_ecma_transforms_base: patch
166+
---
167+
168+
fix(es/renamer): Check `preserved` in normal renaming mode
169+
```
170+
171+
You need to list the `crate names: patch | minor | major` in the front matter (`---` section).
172+
If you are not sure, you can skip it and the maintainer will help you.
173+
159174
## Contributing to the documentation
160175
161176
The SWC documentation can be found at [`swc-project/website`](https://github.com/swc-project/website/tree/main/pages/docs).

0 commit comments

Comments
 (0)