Skip to content

Document lint command and pre-commit hook - #54

Merged
vl3c merged 1 commit into
mainfrom
docs/pre-commit-hook
Sep 18, 2026
Merged

vl3c merged 1 commit into
mainfrom
docs/pre-commit-hook

Conversation

@vl3c

@vl3c vl3c commented Sep 18, 2026

Copy link
Copy Markdown
Owner

Summary

The pre-commit hook (hooks/pre-commit) and the test lint CLI command weren't mentioned in any docs; only the code referenced them. This PR adds:

  • cli/README.md
    • A new Linting section: usage, all options (checked against test lint --help), and what the hook does, including the main-repo venv lookup for worktrees added in Find main repo venv in pre-commit hook when run from a worktree #53.
    • A note that the installed hook is a copy and must be reinstalled when hooks/pre-commit changes.
    • Linting added to the Overview and to the tests.py architecture notes.
  • README.md
    • An optional step 5 in §4.2 Environment Setup that installs the hook.
    • A linting entry in §6.8 Testing.

Note

--install-hook currently fails with FileNotFoundError from a linked worktree: it writes to <worktree>/.git/hooks/, but in a worktree .git is a file. For now the docs say to run it from the main checkout. A code fix can follow in a separate PR, which would drop that caveat.

🤖 Generated with Claude Code

The pre-commit hook and `test lint` CLI command were not mentioned in
any docs. Add a Linting section to cli/README.md (options, hook
behaviour including worktree venv lookup, reinstall note), an optional
hook-install step to README setup, and a linting entry under Testing.
@vl3c
vl3c merged commit a47ca2f into main Sep 18, 2026
1 check passed
@vl3c
vl3c deleted the docs/pre-commit-hook branch September 18, 2026 19:26
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.

1 participant