Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
10 changes: 10 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,14 @@
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.6.0
hooks:
- id: check-yaml
- id: detect-private-key
- id: check-added-large-files
args: ["--maxkb=1000"]
- id: end-of-file-fixer
- id: trailing-whitespace

- repo: https://github.com/pycqa/isort
rev: "7.0.0"
hooks:
Expand Down
12 changes: 12 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,18 @@ When developing features that interact with LLMs:
2. **Integration Testing**: Use your actual API key and configure `api_base` if using alternative providers
3. **Cost Management**: Consider using cheaper models or [optillm](https://github.com/codelion/optillm) for rate limiting during development

### Pre-commit Checks

Before opening a PR, install and run the configured pre-commit hooks:

```bash
pip install pre-commit
pre-commit install
pre-commit run --all-files
```

These hooks catch common issues early, including malformed YAML, accidental private key commits, trailing whitespace, and overly large files.

## Pull Request Process

1. Create a new branch for your feature or bugfix: `git checkout -b feat-your-feature-name`
Expand Down