Skip to content

docs(dev): add pre-commit hook installation guide to contributor guides - #23

Merged
nquyencubas523-cloud merged 2 commits into
cosmo-wander-ai:mainfrom
AdarshJ173:docs/pre-commit-hook-installation
Aug 6, 2026
Merged

docs(dev): add pre-commit hook installation guide to contributor guides#23
nquyencubas523-cloud merged 2 commits into
cosmo-wander-ai:mainfrom
AdarshJ173:docs/pre-commit-hook-installation

Conversation

@AdarshJ173

Copy link
Copy Markdown
Contributor

Adds documentation for the local Git pre-commit hook installation to both English and Chinese contributor guides. Fixes #19

AdarshJ173 added 2 commits July 6, 2026 12:51
- Document scripts/install-hooks.sh usage in both English and Chinese contributor guides
- Explain what the hook checks (clang-format + optional cppcheck)
- Show manual check commands for users who prefer not to install the hook
- Fixes cosmo-wander-ai#19

Signed-off-by: AdarshJ173 <adarshj173@gmail.com>
@samuel--hu

Copy link
Copy Markdown
Contributor

Thanks for the contribution! The documentation content looks good for #19, and the English/Chinese updates are aligned.

I also verified the docs build locally with:

npm run docs:build

Before we merge, could you please clean up the commit history / DCO? The PR currently includes an extra merge commit:

Merge remote-tracking branch 'upstream/main' into docs/pre-commit-hook-installation

That merge commit is not signed off, while this repository requires DCO sign-off for commits. Please rebase your branch onto the latest main and force-push so the PR keeps a clean signed-off history, ideally just the documentation commit(s) with Signed-off-by:.

One small non-blocking doc suggestion: it would be helpful to add a short note that bash scripts/install-hooks.sh and rm .git/hooks/pre-commit should be run from a Bash environment such as Git Bash or WSL on Windows. Contributors who do not install the hook can still use the manual check commands you added.

Thanks again — this is a good scoped first contribution.

@nquyencubas523-cloud nquyencubas523-cloud left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed against current main (1a1cab83).

The English and Chinese guides are aligned, and the documented install, uninstall, clang-format, and optional cppcheck commands match the current repository scripts.

Verification:

  • Clean integration with current main
  • npm run docs:verify — PASS
    • bilingual documentation/link checks passed
    • VitePress production build passed
    • rendered-page smoke tests passed (10 bilingual pages)

This PR will be squash-merged so the history-only unsigned merge commit is excluded while the contributor's existing Signed-off-by trailer is preserved.

@nquyencubas523-cloud
nquyencubas523-cloud merged commit 213f920 into cosmo-wander-ai:main Aug 6, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: document local pre-commit hook installation

3 participants