From 5bc2508da4645ea341445c7843743cc58e4d012b Mon Sep 17 00:00:00 2001
From: Sam Goldman <samgoldman12@gmail.com>
Date: Sat, 13 Jul 2024 16:40:26 -0400
Subject: [PATCH] docs: add contributing guide

---
 CONTRIBUTING.md | 33 +++++++++++++++++++++++++++++++++
 README.md       | 26 +-------------------------
 docs/SUMMARY.md |  1 +
 3 files changed, 35 insertions(+), 25 deletions(-)
 create mode 100644 CONTRIBUTING.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..36e8374
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -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
+```
diff --git a/README.md b/README.md
index 55b7049..8ea945c 100644
--- a/README.md
+++ b/README.md
@@ -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
 
diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md
index fcc4548..a592790 100644
--- a/docs/SUMMARY.md
+++ b/docs/SUMMARY.md
@@ -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)