From 4b4994480feec4443bebebf3827b8c437143a647 Mon Sep 17 00:00:00 2001
From: Nick Tomlin <NickTomlin@users.noreply.github.com>
Date: Thu, 5 Sep 2024 09:56:28 -0500
Subject: [PATCH] chore: First draft of adding CONTRIBUTING.md

---
 CONTRIBUTING.md | 47 +++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 47 insertions(+)
 create mode 100644 CONTRIBUTING.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
new file mode 100644
index 0000000..3193b7e
--- /dev/null
+++ b/CONTRIBUTING.md
@@ -0,0 +1,47 @@
+# Contributing
+
+## Your first contribution
+
+### Setting up the repository
+
+1. Fork this repository
+2. Create a new feature branch
+
+```bash
+git checkout -b my-feature-branch
+```
+
+### Setting up a development environment
+
+1. Ensure that you have `Node.js` installed on your machine (you can use [fnm](https://github.com/Schniz/fnm) or [nvm](https://github.com/nvm-sh/nvm) to easily manage versions)
+2. Install the dependencies with [pnpm](https://pnpm.io/installation) :warning: yarn or npm aren't supported :warning:
+
+- You can check the `packageManager` field of [`package.json`](https://github.com/jsonnext/codemirror-json-schema/blob/main/package.json#L26) to know what version of pnpm to install
+
+```bash
+pnpm install
+```
+
+3. Run tests to ensure your project is in a good state
+
+```bash
+pnpm test
+```
+
+### Making your changes
+
+1. Make whatever code changes you need
+2. Add or update tests coverage whenever possible
+
+### Verifying
+
+1. Run the tests `pnpm run test`
+2. View the changes in the demo site locally `pnpm run dev`
+3. Ensure that the project builds properly `pnpm run tsc`
+
+### Opening a pull request
+
+1. [Add a changeset](https://github.com/changesets/changesets/blob/main/docs/adding-a-changeset.md) describing your changes
+2. Format your code with prettier: `pnpm run prettier:write`
+3. Push your changes to your feature branch
+4. Open a pull request from your fork to the original repository in the Github UI or [CLI](https://cli.github.com/manual/gh_pr_create)