nebari-dev / nebari-dev/nebari-docs
[DOC] - Swap order of yarn install/pre-commit install
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 21
- Forks
- 40
- Avg merge
- 19h 50m
- Merged PRs (30d)
- 6
Description
Preliminary Checks
- This issue is not a question, feature request, RFC, or anything other than a bug report. Please post those things in GitHub Discussions: https://github.com/nebari-dev/nebari/discussions
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.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Open the “Install documentation dependencies” section linked in the issue and review the current yarn and pre-commit instructions. Update the documented order so the setup avoids the core.hooksPath error and preserves both hooks. Verify the rendered contributing documentation shows the corrected sequence.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100