diff --git a/.gitignore b/.gitignore index e22fc24f3..358363b82 100755 --- a/.gitignore +++ b/.gitignore @@ -3,12 +3,6 @@ # dependencies /node_modules /.pnp -.yarn/* -!.yarn/patches -!.yarn/releases -!.yarn/plugins -!.yarn/sdks -!.yarn/versions .pnp.* # testing diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 47190b5cf..a5949c268 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -12,15 +12,21 @@ Here is a quick guide to doing code contributions to the library. 3. Install packages by running: - > yarn + ```shellscript + pnpm install + ``` 4. Startup a local version of the docs - > yarn start + ```shellscript + pnpm run dev + ``` 5. Ensure your code is formatted properly - > yarn format + ```shellscript + pnpm run format + ``` 6. Push your branch: `git push -u origin your-meaningful-branch-name` @@ -28,9 +34,30 @@ Here is a quick guide to doing code contributions to the library. 8. Choose a descriptive title and describe your changes briefly. +## Testing production build + +To test the documentation production site on your local machine, +first execute the build script: + +```shellscript +pnpm run build +``` + +Then start a local server which serves the file created by executing + +```shellscript +pnpm run start +``` + ## Coding style -Please follow the coding style of the project. React Hook Form uses prettier. If possible, enable the prettier plugin in your editor to get real-time feedback. The formatting can be run manually with the following command: `yarn format` +Please follow the coding style of the project. +React Hook Form uses prettier. +If possible, enable the prettier plugin in your editor to get real-time feedback. The formatting can be run manually with the following command: + +```shellscript +pnpm run format +``` ## License diff --git a/README.md b/README.md index 35a616a1a..b6b05d866 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,9 @@ ## Install - yarn && yarn start +```shellscript +pnpm install && pnpm dev +``` ## Backers diff --git a/package.json b/package.json index 97d3a76a3..acf704136 100644 --- a/package.json +++ b/package.json @@ -60,14 +60,14 @@ "dev": "next dev", "format": "prettier --write", "lint": "next lint --fix", - "now-build": "npm run build", + "now-build": "pnpm run build", "start": "next start", "typecheck": "tsc --noEmit", "prepare": "husky install" }, "lint-staged": { "*.{ts,tsx,mdx,css,json}": [ - "npm run format" + "pnpm run format" ] } }