Pull Requests

​

Branch and commit

git checkout -b your-name/short-description
# Make changes, then:
git add <files>
git commit -m "Brief description of the change"

​

Before submitting

uv run ruff check .

uv run ruff format --check .

uv run pytest tests/unit/ -x -q

​

Create the PR

gh pr create --title "Brief title" --body "What and why"

git push -u origin your-name/short-description

​

PR guidelines

• Keep PRs focused — one logical change per PR. Split unrelated changes into separate PRs.
• Include tests for new functionality. Reviewers will ask for them if they are missing.
• Update documentation if you change public APIs, add new agent types, or modify configuration.
• New examples auto-appear in the docs on the next build. No extra docs work needed.
• New VCR cassettes — if you record cassettes for integration tests, include them in the PR.
• PR title — use imperative mood: “Add retry logic to task executor”, not “Added retry logic”.
• PR body — explain what changed and why. Link related issues with Fixes #123 or Closes #123.

​

Review process

1. Address feedback by pushing new commits (do not force-push during review — it erases comment context).
2. Mark conversations as resolved after addressing them.
3. Re-request review after pushing fixes if the reviewer has not re-reviewed.

​

Code owners

​

CI

1. Ruff — lint and format checks
2. Unit tests — tests/unit/
3. Integration tests — tests/integration/ with VCR replay

# Check which step failed in the GitHub Actions log, then reproduce locally:
uv run ruff check .
uv run pytest tests/unit/ -x -v

​

Merging

git branch -d your-name/short-description
git push origin --delete your-name/short-description