Skip to content

Commit 4bee317

Browse files
authored
Merge pull request #106 from token-js/pate/update-contributing
fix: Update contributing guide to include updating the docs
2 parents a817163 + d61893f commit 4bee317

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

CONTRIBUTING.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,17 @@ git commit -m "fix: linter suggestions"
4040

4141
> Sometimes the linter may suggest changes that it is not able to fix itself, you should make sure to review and fix them manually before opening a pull request or the linter will block your PR during review.
4242
43+
### Make sure the docs are updated
44+
```bash
45+
pnpm docs:update
46+
```
47+
48+
> You'll generally only need to update to docs if you [modify the models object](https://github.com/token-js/token.js/blob/main/src/models.ts).
49+
4350
### Add a changeset
4451

4552
```bash
46-
yarn changeset
53+
pnpm changeset
4754
```
4855

4956
> Adding a changeset ensures that a new release will be triggered with your changes once they are reviewed and merged. Please make sure to select an appropriate change level (major, minor, patch) and provide a concise description of the change. Your description will be included in the public facing changelog.

0 commit comments

Comments
 (0)