Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

replace all yarn in CONTRIBUTING.md with pnpm #9605

Merged
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
20 changes: 10 additions & 10 deletions CONTRIBUTING.md
Expand Up @@ -12,30 +12,30 @@ Here is a quick guide to doing code contributions to the library.

3. Install packages by running:

> yarn
> pnpm install

4. If you've added a code that should be tested, ensure the test suite still passes.

> yarn test && yarn tsd
> pnpm test && pnpm tsd

5. Try to write some unit tests to cover as much of your code as possible.

6. Ensure your code lints without errors.

> yarn lint
> pnpm lint

7. Ensure the automation suite passes by running two following commands in parallel:

> yarn start
> yarn cypress
> pnpm start
> pnpm cypress

8. Ensure build passes.

> yarn build
> pnpm build

9. Ensure exports are documented. (requires build)

> yarn api-extractor
> pnpm api-extractor

10. Push your branch: `git push -u origin your-meaningful-branch-name`

Expand All @@ -45,7 +45,7 @@ Here is a quick guide to doing code contributions to the library.

## Coding style

Please follow the coding style of the project. React Hook Form uses eslint and prettier. If possible, enable their respective plugins in your editor to get real-time feedback. The linting can be run manually with the following command: `yarn lint:fix` and `yarn prettier:fix`
Please follow the coding style of the project. React Hook Form uses eslint and prettier. If possible, enable their respective plugins in your editor to get real-time feedback. The linting can be run manually with the following command: `pnpm lint:fix` and `pnpm prettier:fix`

## Visual Debugging Jest

Expand All @@ -68,11 +68,11 @@ it('should render correctly', () => {

2. Open Jest Preview Dashboard

> yarn jest-preview
> pnpm jest-preview

3. Run the tests

> yarn test:watch
> pnpm test:watch

The browser will reloads automatically when `debug()` is executed.

Expand Down