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
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,22 +5,22 @@ Thanks for contributing!
5
5
### Installing dependencies
6
6
7
7
```sh
8
-
yarn install
8
+
pnpm install
9
9
```
10
10
11
-
You will find all building blocks that make up React Live in the [`src`](packages/react-live/src) folder and examples in the [`demo`](demo) folder.
11
+
You will find all building blocks that make up React Live in the [`src`](packages/react-live/src) folder and examples in the [`demo`](packages/demo) folder.
12
12
13
13
### Testing
14
14
15
-
You will find tests for files colocated with `*.test.js` suffixes. Whenever making any changes, ensure that all existing tests pass by running `yarn run test`.
15
+
You will find tests for files colocated with `*.test.js` suffixes. Whenever making any changes, ensure that all existing tests pass by running `pnpm run test` in the react-live directory.
16
16
17
17
If you are adding a new feature or some extra functionality, you should also make sure to accompany those changes with appropriate tests.
18
18
19
19
### Linting and Formatting
20
20
21
-
Before committing any changes, be sure to do `yarn run lint`; this will lint all relevant files using [ESLint](http://eslint.org/) and report on any changes that you need to make.
21
+
Before committing any changes, be sure to do `pnpm run lint`; this will lint all relevant files using [ESLint](http://eslint.org/) and report on any changes that you need to make.
22
22
23
-
You will also want to ensure your code meets the prettier formatting guidelines by running `yarn run prettier -l <filename>` on a specific file. If there are differences the script errors out. You can also specify a glob `yarn run prettier -l "src/**/*.js"` which will return a list of files that do not conform.
23
+
You will also want to ensure your code meets the prettier formatting guidelines by running `pnpm run prettier -l <filename>` on a specific file. If there are differences the script errors out. You can also specify a glob `yarn run prettier -l "src/**/*.js"` which will return a list of files that do not conform.
24
24
25
25
Alternatively, install the Prettier [editor plugin](https://prettier.io/docs/en/editors.html) in your favorite editor. This is the preferred method.
26
26
@@ -30,8 +30,8 @@ There is also a CI step in place to lint all committed files. If any of the stag
30
30
31
31
Thanks for taking the time to help us make react-live even better! Before you go ahead and submit a PR, make sure that you have done the following:
32
32
33
-
- Run the tests using `yarn run test`.
34
-
- Run lint and flow using `yarn run lint`
33
+
- Run the tests using `pnpm run test`.
34
+
- Run lint and flow using `pnpm run lint`
35
35
- Update the [type definitions](./typings/react-live.d.ts) for anything that modifies the React-Live API, like breaking changes or new features.
36
36
37
37
### Changesets
@@ -41,7 +41,7 @@ We use [changesets](https://github.com/changesets/changesets) to create package
41
41
If your work contributes changes that require a change in version to any of the packages, add a changeset by running:
42
42
43
43
```sh
44
-
$ yarn changeset
44
+
$ pnpm changeset
45
45
```
46
46
47
47
which will open an interactive CLI menu. Use this menu to select which packages need versioning, which semantic version changes are needed, and add appropriate messages accordingly.
0 commit comments