Skip to content

Commit 8f050b4

Browse files
chore(docs): add changeset guide to contributing.md (#219)
* chore(docs): add changeset guide to contributing.md * chore: text changes to changeset guide * Update CONTRIBUTING.md --------- Co-authored-by: Eric Allam <eallam@icloud.com>
1 parent 3cf01ff commit 8f050b4

1 file changed

Lines changed: 20 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -175,6 +175,26 @@ The [examples/jobs-starter](./examples/jobs-starter/) project defines simple job
175175
](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue).
176176
- Be sure to fill the PR Template accordingly.
177177

178+
## Adding changesets
179+
180+
We use [changesets](https://github.com/changesets/changesets) to manage our package versions and changelogs. If you've never used changesets before, first read [their guide here](https://github.com/changesets/changesets/blob/main/docs/adding-a-changeset.md).
181+
182+
If you are contributing a change to any packages in this monorepo (anything in either the `/packages` or `/integrations` directories), then you will need to add a changeset to your Pull Requests before they can be merged.
183+
184+
To add a changeset, run the following command in the root of the repo
185+
186+
```shell
187+
pnpm run changeset:add
188+
```
189+
190+
Here's an example of creating a `patch` changeset for the `@trigger.dev/github` and `@trigger.dev/slack` packages (click to view):
191+
192+
[![asciicast](https://asciinema.org/a/599228.svg)](https://asciinema.org/a/599228)
193+
194+
You will be prompted to select which packages to include in the changeset. Only select the packages that you have made changes for (Important: never include a changeset for the `@trigger.dev/internal` package, as it's bundled with other packages and should not be published).
195+
196+
Most of the time the changes you'll make are likely to be categorized as patch releases. If you feel like there is the need for a minor or major release of the package based on the changes being made, add the changeset as such and it will be discussed during PR review.
197+
178198
## Troubleshooting
179199

180200
### EADDRINUSE: address already in use :::3030

0 commit comments

Comments
 (0)