docs: add CONTRIBUTING.md

sor4chi · Dec 3, 2023 · 8b15ef0 · 8b15ef0
1 parent 509c2e3
commit 8b15ef0
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,33 @@
+# Contributing Guide
+
+You are welcome to contribute to this project.
+
+1. Raise an issue to discuss your idea.
+2. Fork this repo.
+3. Make your changes.
+4. Open a pull request.
+
+## Getting Started
+
+```bash
+pnpm i
+```
+
+### Testing
+
+```bash
+pnpm test # for unit tests
+pnpm test:type # for type tests
+```
+
+### Linting
+
+```bash
+pnpm lint
+```
+
+### Building
+
+```bash
+pnpm build
+```
diff --git a/README.md b/README.md
@@ -43,3 +43,4 @@ You want to find more? Check out the [examples](./examples)!
 ## Contributing
 
 This project is open for contributions. Feel free to open an issue or a pull request!
+[Contributing Guide](./CONTRIBUTING.md) for more information.