diff --git a/AGENTS.md b/AGENTS.md index 7a5eb5c..dfaeab5 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -129,17 +129,15 @@ uv run pytest --cov=workflows --cov=activities ## Linting and Code Quality ```bash -# Format code +# Using poe tasks +uv run poe format # Format code with black and isort +uv run poe lint # Check code style and types +uv run poe test # Run test suite + +# Manual commands uv run black . uv run isort . - -# Check code style and types -uv run black --check . -uv run isort --check-only . uv run mypy --check-untyped-defs --namespace-packages . - -# Run test suite -uv run pytest ``` ## Agent Customization diff --git a/docs/contributing.md b/docs/contributing.md index 5e19019..c4d8c8f 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -8,14 +8,22 @@ This document provides guidelines for contributing to `temporal-ai-agent`. All s We use `black` for code formatting and `isort` for import sorting to maintain a consistent codebase. - **Format code:** ```bash + uv run poe format + ``` + Or manually + ``` uv run black . uv run isort . ``` Please format your code before committing. ### Linting & Type Checking -We use `mypy` for static type checking. -- **Run type checks:** +We use `mypy` for static type checking and other linters configured via `poe`. +- **Run linters and type checks:** + ```bash + uv run poe lint + ``` + Or manually for type checking: ```bash uv run mypy --check-untyped-defs --namespace-packages . ```