Merge branch 'main' into completion-markdown-rendering

.changeset/sixty-pillows-work.md

@@ -0,0 +1,5 @@
+---
+"codemirror-json-schema": patch
+---
+
+Move non essential packages to devDependencies

.changeset/tender-rocks-smell.md

@@ -0,0 +1,5 @@
+---
+"codemirror-json-schema": patch
+---
+
+Add CONTRIBUTING.md file

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. Once your branch is ready, and it contains bugfixes, documentation improvements or features, run `pnpm changeset add` to add a [changeset](https://github.com/changesets/changesets/blob/main/docs/adding-a-changeset.md) file
+   - There you can compose the markdown entry describing your changes that will be published in CHANGELOG.md
+2. Push your changes to your feature branch
+3. 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)

package.json

@@ -57,17 +57,13 @@
   "repository": "github:acao/codemirror-json-schema",
   "homepage": "https://codemirror-json-schema.netlify.app/",
   "dependencies": {
-    "@changesets/changelog-github": "^0.4.8",
     "@sagold/json-pointer": "^5.1.1",
     "@shikijs/markdown-it": "^1.1.7",
-    "@types/json-schema": "^7.0.12",
-    "@types/node": "^20.4.2",
     "best-effort-json-parser": "^1.1.2",
     "json-schema": "^0.4.0",
     "json-schema-library": "^9.3.5",
     "loglevel": "^1.9.1",
     "markdown-it": "^14.0.0",
-    "vite-tsconfig-paths": "^4.3.1",
     "yaml": "^2.3.4"
   },
   "optionalDependencies": {
@@ -85,6 +81,9 @@
     "@lezer/common": "^1.2.1"
   },
   "devDependencies": {
+    "@types/json-schema": "^7.0.12",
+    "@types/node": "^20.4.2",
+    "@changesets/changelog-github": "^0.4.8",
     "@changesets/cli": "^2.26.2",
     "@codemirror/autocomplete": "^6.16.2",
     "@codemirror/commands": "^6.6.0",
@@ -105,7 +104,8 @@
     "typescript": "^5.1.6",
     "vite": "^5.2.12",
     "vitest": "0.34.6",
-    "vitest-dom": "^0.1.0"
+    "vitest-dom": "^0.1.0",
+    "vite-tsconfig-paths": "^4.3.1"
   },
   "scripts": {
     "dev": "vite ./dev --port 3000",