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.

Sign up for GitHub

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

Jump to bottom

fix: Update contributing guide to include updating the docs #106

Merged
merged 1 commit into from
Aug 16, 2024
Merged

fix: Update contributing guide to include updating the docs #106

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
9 changes: 8 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,17 @@ git commit -m "fix: linter suggestions"

> 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.

### Make sure the docs are updated
```bash
pnpm docs:update
```

> 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).

### Add a changeset

```bash
yarn changeset
pnpm changeset
```

> 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.