diff --git a/README.md b/README.md index 23fc792447..1e81bd71b5 100644 --- a/README.md +++ b/README.md @@ -110,6 +110,8 @@ yarn husky install npx husky add .husky/commit-msg 'npx --no-install commitlint --edit "$1"' ``` +**Please note that currently @commitlint/cli doesn't support yarn v2 Plug'n'Play (using yarn v2 with `nodeLinker: node-modules` in your .yarnrc.yml file may work sometimes)** + Check the [husky documentation](https://typicode.github.io/husky/#/?id=manual) on how you can automatically have Git hooks enabled after install for different `yarn` versions. **Detailed Setup instructions** diff --git a/docs/guides-local-setup.md b/docs/guides-local-setup.md index ed2abc845a..70e50691d3 100644 --- a/docs/guides-local-setup.md +++ b/docs/guides-local-setup.md @@ -38,6 +38,7 @@ npx husky add .husky/commit-msg 'npx --no-install commitlint --edit $1' yarn husky add .husky/commit-msg 'yarn commitlint --edit $1' ``` +**Please note that currently @commitlint/cli doesn't support yarn v2 Plug'n'Play (using yarn v2 with `nodeLinker: node-modules` in your .yarnrc.yml file may work sometimes)** Check the [husky documentation](https://typicode.github.io/husky/#/?id=manual) on how you can automatically have Git hooks enabled after install for different `yarn` versions. ## Test