Files
dora-image-view/AGENTS.md
T
cristhian 363bf006be lint markdown recursively
`scan *.md` only matched the repository root, so a file added under any
subdirectory would have stopped being checked without the CI step noticing.
Scanning recursively follows the files instead of the layout, and
--respect-gitignore keeps it off .venv and .dora.
2026-09-15 06:20:14 -03:00

1.3 KiB

AGENTS.md

Rules for AI coding assistants working in this repository.

  • dora >= 1.0. Verified against dora-cli 1.0.1, which CI pins in .github/workflows/validate.yml.

  • uv for everything: uv sync --group dev, uv run pytest, uv run ruff check ., uv run python .... Never pip into the ambient environment. A node's build: is uv pip install ., so dataflows must be run with --uv.

  • ruff is the linter and the formatter. uv run ruff check . must be clean.

  • Markdown is linted too. uv run pymarkdown scan -r --respect-gitignore . must be clean. Its line length is set in pyproject.toml.

  • numpy-style docstrings.

  • Dependencies must ship prebuilt wheels for linux-x86_64, linux-aarch64 and macos-arm64. uv sync is the whole install: no system packages, no compiler.

  • Run the workflow locally with act before asking for a commit:

    act pull_request -P ubuntu-latest=catthehacker/ubuntu:act-latest
    

    Workflows live in .github/workflows/, not .gitea/workflows/, so that act finds them with no -W. Gitea Actions reads both locations; keep only this one, or a run fires twice.

  • Do not commit or push. Leave changes in the working tree and wait to be asked.

  • Do not mention AI tools in commit messages or documentation.