Skip to content

docs: add lefthook setup instructions to workspace docs #52

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mairas merged 1 commit into from
Dec 17, 2025
Merged

docs: add lefthook setup instructions to workspace docs #52

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# HaLOS Workspace - Agentic Coding Hub

**LAST MODIFIED**: 2025-12-10
**LAST MODIFIED**: 2025-12-17

**Document Purpose**: Central workspace for agentic coding with Claude Code and other AI assistants. This workspace provides full context across all HaLOS repositories for optimal AI-assisted development.

Expand All @@ -26,6 +26,8 @@ This workspace manages multiple independent repositories. While each repository

**PR Reviews**: When reviewing pull requests, always post review comments directly on the PR itself using `gh pr comment`. This ensures feedback is visible to all stakeholders and preserved in the project history.

**Pre-commit Hooks**: Repositories use [lefthook](https://github.com/evilmartians/lefthook) for pre-commit hooks. After cloning, install hooks with `./run hooks-install`. See `docs/LIFE_WITH_CLAUDE.md` for details.

## Structure

```
Expand Down
24 changes: 24 additions & 0 deletions docs/LIFE_WITH_CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,6 +186,30 @@ I have no strong opinion on MCPs at this point. I do have [ck-search](https://gi

Hooks are user-defined shell commands that can be set to execute at specific points during Claude's operation. They can, for example, be used to validate commands before execution. I have not used them much, except for one thing: `git add -A` is something Claude likes to do, and it pulls in unwanted cruft. I asked Claude to create a hook to forbid that command, and voila! Problem solved.

## Git Pre-commit Hooks with Lefthook

To catch formatting and linting issues before they reach CI, HaLOS repositories use [lefthook](https://github.com/evilmartians/lefthook) for git pre-commit hooks. This ensures CI checks don't fail due to formatting issues that should have been caught locally.

**One-time Setup:**

```bash
# Install lefthook
brew install lefthook
```

**Per-repository Setup:**

After cloning any HaLOS repository that has a `lefthook.yml`, install the hooks:

```bash
./run hooks-install
```

This enables pre-commit hooks that run format and lint checks matching what CI runs. To skip hooks when needed (e.g., WIP commits):

```bash
git commit --no-verify -m "WIP: message"
```

## References

Expand Down