Skip to content

Document pre-commit hook setup #12

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

Closed
agentlaunchops-ai wants to merge 1 commit into from
Closed

Document pre-commit hook setup #12

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
9 changes: 8 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,17 @@ source .venv/bin/activate # Windows: .venv\Scripts\activate
# 3. Install the package in editable mode with dev dependencies
pip install -e ".[dev]"

# 4. Verify the CLI is available
# 4. Install the local pre-commit hooks
pip install pre-commit
pre-commit install

# 5. Verify the CLI is available
anglerfish --version
```

The pre-commit hooks run `ruff check --fix` and `ruff-format`, mirroring the
style gates enforced in CI.

---

## Running Tests and Linting
Expand Down