Skip to content

Commit 3f1fb9d

Browse files
committed
Merge branch 'main' of https://github.com/token-js/token.js
2 parents e8ae98f + 041dfb4 commit 3f1fb9d

File tree

1 file changed

+19
-3
lines changed

1 file changed

+19
-3
lines changed

CONTRIBUTING.md

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ Thanks for your interest in improving Token.js!
55
We appreciate support in the following areas:
66
- 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).
77
- 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.
8+
- 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.
89

910
## Development Quickstart
1011

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

1920
```bash
20-
cd llm && pnpm install
21+
cd token-js && pnpm install
2122
```
2223

2324
### Test your changes
@@ -26,8 +27,23 @@ cd llm && pnpm install
2627
pnpm test
2728
```
2829

29-
### Run the linter
30+
### Run the linter, fix and commit any suggestions
3031

3132
```bash
32-
pnpm lint
33+
pnpm lint:fix
3334
```
35+
36+
```bash
37+
git add .
38+
git commit -m "fix: linter suggestions"
39+
```
40+
41+
> 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.
42+
43+
### Add a changeset
44+
45+
```bash
46+
yarn changeset
47+
```
48+
49+
> 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)