From 4eba2ee92b71b75bde49db249a23cb00271a7e0f Mon Sep 17 00:00:00 2001 From: yihong Date: Mon, 25 Aug 2025 11:14:04 +0800 Subject: [PATCH] docs: better doc for dev in api like Claude.md (#24442) Signed-off-by: yihong0618 --- api/README.md | 14 +++++++++++--- 1 file changed, 11 insertions(+), 3 deletions(-) diff --git a/api/README.md b/api/README.md index 9e31172ac4..8309a0e69b 100644 --- a/api/README.md +++ b/api/README.md @@ -97,8 +97,16 @@ uv run celery -A app.celery beat uv sync --dev ``` -1. Run the tests locally with mocked system environment variables in `tool.pytest_env` section in `pyproject.toml` +1. Run the tests locally with mocked system environment variables in `tool.pytest_env` section in `pyproject.toml`, more can check [Claude.md](../CLAUDE.md) - ```bash - uv run -P api bash dev/pytest/pytest_all_tests.sh + ```cli + uv run --project api pytest # Run all tests + uv run --project api pytest tests/unit_tests/ # Unit tests only + uv run --project api pytest tests/integration_tests/ # Integration tests + + # Code quality + ./dev/reformat # Run all formatters and linters + uv run --project api ruff check --fix ./ # Fix linting issues + uv run --project api ruff format ./ # Format code + uv run --project api mypy . # Type checking ```