Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
  • Loading branch information
lawrencecchen committed Jul 30, 2024
2 parents e8ae98f + 041dfb4 commit 3f1fb9d
Showing 1 changed file with 19 additions and 3 deletions.
22 changes: 19 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ Thanks for your interest in improving Token.js!
We appreciate support in the following areas:
- Reporting issues. If you notice any bugs or have suggestions for new features, please [open an issue](https://github.com/token-js/token.js/issues/new).
- Fixing and responding to existing issues. You can start off with those tagged ["good first issue"](https://github.com/token-js/token.js/labels/good%20first%20issue), which are meant as introductory issues for external contributors.
- Supporting new providers. We recommend first opening an issue and contacting the maintainers to get guidance on this as we have not yet documented the complete process of supporting new providers.

## Development Quickstart

Expand All @@ -17,7 +18,7 @@ git clone https://github.com/token-js/token-js.git
### Open the project and install the dependencies

```bash
cd llm && pnpm install
cd token-js && pnpm install
```

### Test your changes
Expand All @@ -26,8 +27,23 @@ cd llm && pnpm install
pnpm test
```

### Run the linter
### Run the linter, fix and commit any suggestions

```bash
pnpm lint
pnpm lint:fix
```

```bash
git add .
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.
### Add a changeset

```bash
yarn 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.

0 comments on commit 3f1fb9d

Please sign in to comment.