Skip to content

Commit bceace2

Browse files
authored
Add Contributing.md (#140)
1 parent 4fd7cc6 commit bceace2

File tree

2 files changed

+52
-0
lines changed

2 files changed

+52
-0
lines changed

.changeset/tender-rocks-smell.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"codemirror-json-schema": patch
3+
---
4+
5+
Add CONTRIBUTING.md file

CONTRIBUTING.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
# Contributing
2+
3+
## Your first contribution
4+
5+
### Setting up the repository
6+
7+
1. Fork this repository
8+
2. Create a new feature branch
9+
10+
```bash
11+
git checkout -b my-feature-branch
12+
```
13+
14+
### Setting up a development environment
15+
16+
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)
17+
2. Install the dependencies with [pnpm](https://pnpm.io/installation) :warning: yarn or npm aren't supported :warning:
18+
19+
- 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
20+
21+
```bash
22+
pnpm install
23+
```
24+
25+
3. Run tests to ensure your project is in a good state
26+
27+
```bash
28+
pnpm test
29+
```
30+
31+
### Making your changes
32+
33+
1. Make whatever code changes you need
34+
2. Add or update tests coverage whenever possible
35+
36+
### Verifying
37+
38+
1. Run the tests `pnpm run test`
39+
2. View the changes in the demo site locally `pnpm run dev`
40+
3. Ensure that the project builds properly `pnpm run tsc`
41+
42+
### Opening a pull request
43+
44+
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
45+
- There you can compose the markdown entry describing your changes that will be published in CHANGELOG.md
46+
2. Push your changes to your feature branch
47+
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)

0 commit comments

Comments
 (0)