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

[DOC] - Swap order of yarn install/pre-commit install #522

Open
1 task done
kcpevey opened this issue Sep 11, 2024 · 0 comments
Open
1 task done

[DOC] - Swap order of yarn install/pre-commit install #522

kcpevey opened this issue Sep 11, 2024 · 0 comments

Comments

@kcpevey
Copy link
Contributor

kcpevey commented Sep 11, 2024

Preliminary Checks

Summary

The documentation contributing docs tell users to
yarn install
THEN
pre-commit install

However, if you do it in that order, you'll get an error. This is because yarn install installs the husky precommit hook. Then when you run pre-commit install you get the error:

[ERROR] Cowardly refusing to install hooks with `core.hooksPath` set.
hint: `git config --unset-all core.hooksPath`

if you follow those directions... the husky pre-commit will no longer work and you'll end up not catching linting/formatting issues until opening a PR.

Steps to Resolve this Issue

It would be nice if we didn't need two different avenues for pre-commits - not sure the history on this. At the very least, if we just tell users to install pre-commit first, then run yarn install, it should fix this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Todo 📬
Development

No branches or pull requests

1 participant