nebari-dev / nebari-dev/nebari-docs

[BUG] - Inconsistency in the pre-commit hooks section of the Contribute to Nebari's documentation page

Open
#386 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

good first issue needs: PR 📬 type: bug 🐛
Dominant language
No language data
Stars
21
Forks
40
Avg merge
19h 50m
Merged PRs (30d)
6

Description

Describe the bug

The Pre-commit hooks section in the Contribute to Nebari's documentation page states the following:

Similar to the Nebari codebase, the nebari-docs repository uses a number of pre-commit hooks to standardize our YAML and Markdown structure.

  1. Navigate to the root of this project. If you're in the docs subdirectory, you can run "cd .." to go back to the root.
  2. Follow the instructions in the Pre-commit hooks section of Contribute to Nebari's codebase to install the pre-commit hooks.

When following those instructions and running pre-commit install, I get the following error:

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

Upon further inspection and running git config --list, I see the following entry:

core.hookspath=docs/.husky

It seems that Husky is the tool that is actually being used for git hooks in the documentation source code.

Expected behavior

Consistent description on how to setup git hooks for the documentation source code.

How to Reproduce the problem?

Go to the Pre-commit hooks section of the docs website. This can be found here in the source code.

Command output

No response

Versions and dependencies used.

No response

Anything else?

No response

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open docs/docs/community/doc-contributions.md at the pre-commit hooks section and compare its instructions with the documentation repository's actual git hook setup, including docs/.husky and the reported core.hooksPath setting. Update the section so contributors have consistent, working setup instructions, then verify the linked documentation page no longer recommends the conflicting workflow.

Written by the indexing model from the issue text.

Assessment

Tech stack
git
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.