docs(dev): add pre-commit hook installation guide to contributor guides - #23
Conversation
- 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>
|
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:buildBefore we merge, could you please clean up the commit history / DCO? The PR currently includes an extra merge commit: That merge commit is not signed off, while this repository requires DCO sign-off for commits. Please rebase your branch onto the latest One small non-blocking doc suggestion: it would be helpful to add a short note that Thanks again — this is a good scoped first contribution. |
nquyencubas523-cloud
left a comment
There was a problem hiding this comment.
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.
Adds documentation for the local Git pre-commit hook installation to both English and Chinese contributor guides. Fixes #19