Skip to content

Commit

Permalink
chore: First draft of adding CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
NickTomlin committed Sep 5, 2024
1 parent 4fd7cc6 commit 4b49944
Showing 1 changed file with 47 additions and 0 deletions.
47 changes: 47 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -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)

0 comments on commit 4b49944

Please sign in to comment.