chore: add CONTRIBUTING.md

QuiiBz · Nov 4, 2023 · 91eb3f2 · 91eb3f2
1 parent 68bc9b1
commit 91eb3f2
Show file tree

Hide file tree

Showing 3 changed files with 32 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,25 @@
+## Contributing
+
+Thanks for your interest in contributing to next-international!
+
+### Requirements
+
+- `node` >= 18
+- `pnpm` >= 8
+
+### Getting Started
+
+1. Fork the repository, then clone it locally
+2. Run `pnpm install` at the root of the repository
+3. Navigate to `packages/international-types` and run `pnpm build`
+4. Navigate to `packages/next-international` and run `pnpm build`
+
+Before submitting a PR, run the `test`, `lint`, and `typecheck` scripts from the root of the repository.
+
+### Running the example apps
+
+Make sure you've followed the [Getting Started](#getting-started), then navigate to `examples/next-{app/pages}` and run `pnpm dev`.
+
+### Running the documentation
+
+You don't need to follow the [Getting Started](#getting-started) for the documentation website. Simply navigate to the `docs` folder and run `pnpm dev`.
diff --git a/docs/pages/index.mdx b/docs/pages/index.mdx
@@ -30,6 +30,9 @@ Try it live on CodeSandbox:
   <Card title="Browse documentation" href="/docs" />
 </Cards>
 
+## Contributing
+
+[See the contributing guide](./CONTRIBUTING.md).
 
 ## Sponsors
 

diff --git a/packages/next-international/README.md b/packages/next-international/README.md
@@ -33,6 +33,10 @@ Try it live on CodeSandbox:
 
 Check out the documentation at [https://next-international.vercel.app](https://next-international.vercel.app).
 
+## Contributing
+
+[See the contributing guide](./CONTRIBUTING.md).
+
 ## Sponsors
 
 ![Sponsors](https://github.com/QuiiBz/dotfiles/blob/main/sponsors.png?raw=true)