This is an automated email from the ASF dual-hosted git repository. tison pushed a commit to branch agents in repository https://gitbox.apache.org/repos/asf/steve.git
commit cdc58a61c4a444c1811b6cdf4a09902964a253c6 Author: tison <[email protected]> AuthorDate: Thu Feb 26 09:19:09 2026 +0800 Add AGENTS.md Signed-off-by: tison <[email protected]> --- AGENTS.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..2f8976e --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,30 @@ +# Coding Agent Context + +This project uses `uv` for dependency management and enforces strict linting, formatting, and type-checking standards. All Coding Agents MUST follow these instructions after generating or modifying code to ensure compatibility with the project's CI/CD pipelines. + +## Post-Generation Checklist + +After making any changes, run the following commands in the `v3/` directory: + +1. **Code Formatting**: Format the code using `ruff`. + ```bash + uv run ruff format . + ``` + +2. **Linting**: Run `ruff` check to identify and fix potential issues. + ```bash + uv run ruff check --fix . + ``` + +3. **Type Checking**: Verify type safety with `mypy`. + ```bash + uv run mypy --ignore-missing-imports . + ``` + +## Development Standards + +- **Language**: All code, documentation, and comments MUST be written in **English**. +- **Dependencies**: Use `uv` for all dependency management tasks (e.g., `uv sync`, `uv run`). +- **CI Alignment**: These steps align with the `.github/workflows/linting.yml` and `.github/workflows/type-tests.yml` configurations. + +Ensure all checks pass before considering a task complete.
