Skip to content

Commit 3206f37

Browse files
Update contributing notes
1 parent 3935465 commit 3206f37

1 file changed

Lines changed: 5 additions & 5 deletions

File tree

CONTRIBUTING.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -104,14 +104,14 @@ Once you have a `dist` folder being created, you can either:
104104
+ import { createHeadlessForm } from '../../path/to/repo/json-schema-form/dist'
105105
```
106106

107-
- Option B: Use [npm link](https://docs.npmjs.com/cli/v9/commands/npm-link) or [yarn link](https://classic.yarnpkg.com/lang/en/docs/cli/link/):
107+
- Option B: Use the `link` command of your project package manager tool to symlink the package build to your project's `node_modules`, e.g. [npm link](https://docs.npmjs.com/cli/v9/commands/npm-link) or [yarn link](https://classic.yarnpkg.com/lang/en/docs/cli/link/). For example, with `npm`:
108108

109109
```bash
110110
# in json-schema-form repo:
111111
$ npm link
112112

113113
# cd to your project
114-
$ npm link @remoteoss/json-schema-form
114+
$ npm link @remoteoss/json-schema-form
115115

116116
# Run npm unlink --no-save @remoteoss/json-schema-form to remove the local symlink
117117
```
@@ -122,7 +122,7 @@ If you need a public release (for example, to run it on your project CI), you ca
122122

123123
Note that only core maintainers can publish public releases. If needed, ask us in the PR and we'll do it for you. Check PR #3 for the video walkthrough.
124124

125-
1. Locally run the script `npm run release:dev:patch` or `npm run release:dev:minor` depending on your changes.
125+
1. Locally run the script `pnpm run release:dev patch` or `pnpm run release:dev minor` depending on your changes.
126126
1. You'll be shown what's the new version and prompt you if it's correct. Eg
127127
```
128128
Creating a new dev...
@@ -138,7 +138,7 @@ Every `dev` release is [tagged as `dev`](https://docs.npmjs.com/cli/v9/commands/
138138
You must specify the exact version, for example:
139139
140140
```bash
141-
npm i -S @remoteoss/json-schema-form@1.0.1-dev.20230516-175718
141+
pnpm i -S @remoteoss/json-schema-form@1.0.1-dev.20230516-175718
142142
```
143143

144144
You can create as many dev releases as you need during the PRs, by running the same command.
@@ -159,7 +159,7 @@ The final release is done after merge.
159159
### Publishing a stable release
160160

161161
1. Checkout `main` and pull the latest commit
162-
2. Depending if you want a `patch` or `minor`, run the command `npm release:main:patch` or `npm release:main:minor`.
162+
2. Depending if you want a `patch` or `minor`, run the command `pnpm run release patch` or `pnpm run release minor`.
163163

164164
1. You'll be shown what's the new version and prompt you if it's correct. Eg
165165

0 commit comments

Comments
 (0)