Skip to content
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.

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

doc(contributing): Document changeset #9667

Merged
merged 1 commit into from
Oct 23, 2024
Merged
Changes from all commits
Commits
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
15 changes: 15 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -156,6 +156,21 @@ passes of review and changes.
Once the reviewer approves your pull request, a friendly bot picks it up
and merges it into the SWC `main` branch.
SWC uses changeset for changelog management with a bit of custom logic.
A changeset for SWC looks like this:
```markdown
---
swc_core: patch
swc_ecma_transforms_base: patch
---
fix(es/renamer): Check `preserved` in normal renaming mode
```
You need to list the `crate names: patch | minor | major` in the front matter (`---` section).
If you are not sure, you can skip it and the maintainer will help you.
## Contributing to the documentation
The SWC documentation can be found at [`swc-project/website`](/~https://github.com/swc-project/website/tree/main/pages/docs).
Expand Down
Loading