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.

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

docs: add contributing guide #69

Merged
merged 1 commit into from
Jul 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
33 changes: 33 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Contributing to Token.js

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.

## Development Quickstart

### Clone the repo

```bash
git clone https://github.com/token-js/token-js.git
```

### Open the project and install the dependencies

```bash
cd llm && pnpm install
```

### Test your changes

```bash
pnpm test
```

### Run the linter

```bash
pnpm lint
```
26 changes: 1 addition & 25 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -191,31 +191,7 @@ This table provides an overview of the features that Token.js supports from each

## Contributing

PRs are accepted!

### Clone the repo

```bash
git clone https://github.com/token-js/token-js.git
```

### Open the project and install the dependencies

```bash
cd llm && pnpm install
```

### Test your changes

```bash
pnpm test
```

### Run the linter

```bash
pnpm lint
```
See our [Contributing guide](./CONTRIBUTING.md) to learn how to contribute to Token.js.

## Contact Us

Expand Down
1 change: 1 addition & 0 deletions docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,3 +12,4 @@
* [OpenAI](providers/openai.md)
* [Perplexity](providers/perplexity.md)
* [Contact Us](contact-us.md)
* [Contributing](https://github.com/token-js/token.js/blob/main/CONTRIBUTING.md)