You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -104,14 +104,14 @@ Once you have a `dist` folder being created, you can either:
104
104
+ import { createHeadlessForm } from '../../path/to/repo/json-schema-form/dist'
105
105
```
106
106
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`:
108
108
109
109
```bash
110
110
# in json-schema-form repo:
111
111
$ npm link
112
112
113
113
# cd to your project
114
-
$ npm link @remoteoss/json-schema-form
114
+
$ npm link @remoteoss/json-schema-form
115
115
116
116
# Run npm unlink --no-save @remoteoss/json-schema-form to remove the local symlink
117
117
```
@@ -122,7 +122,7 @@ If you need a public release (for example, to run it on your project CI), you ca
122
122
123
123
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.
124
124
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:devpatch` or `pnpm run release:devminor` depending on your changes.
126
126
1. You'll be shown what's the new version and prompt you if it's correct. Eg
127
127
```
128
128
Creating a new dev...
@@ -138,7 +138,7 @@ Every `dev` release is [tagged as `dev`](https://docs.npmjs.com/cli/v9/commands/
138
138
You must specify the exact version, for example:
139
139
140
140
```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
142
142
```
143
143
144
144
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.
159
159
### Publishing a stable release
160
160
161
161
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 releasepatch` or `pnpm run releaseminor`.
163
163
164
164
1. You'll be shown what's the new version and prompt you if it's correct. Eg
0 commit comments