Files

T

cristhian 093715e78f add markdown linting and cut AGENTS.md back to rules

AGENTS.md was a per-module tour of the code, which restated what the code says
and had already drifted: it described the example as emitting three inputs when
it emits five. It is now the conventions an agent cannot infer -- dora version,
uv, ruff, numpy docstrings, the platform requirement, act, and what not to do --
and nothing else. The gotchas it carried are explained at their point of use in
the code instead.

pymarkdown lints the markdown, configured in pyproject.toml and run in CI
beside ruff. It caught a fenced block with no language and an over-long table
row. ruff's pydocstyle convention moves to numpy.

GEMINI.md is removed.

2026-09-15 06:03:40 -03:00

1.1 KiB

Raw Blame History

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 .gitea/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.
ruff is the linter and the formatter. uv run ruff check . must be clean.
Markdown is linted too. uv run pymarkdown scan *.md 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. It lives in .gitea/workflows/, which is not where act looks by default:
```
act pull_request -W .gitea/workflows/validate.yml \
    -P ubuntu-latest=catthehacker/ubuntu:act-latest
```
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.

1.1 KiB Raw Blame History

AGENTS.md

1.1 KiB

Raw Blame History