diff --git a/docs/usage.md b/docs/usage.md index 04374a7..8f788bd 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -260,6 +260,17 @@ Use this checklist when configuring GitHub Copilot in VS Code against `personal- 6. verify context size remains bounded 7. validate behavior in Ask/Edit/Agent-style workflows with at least one task each +## Local Ruff Workflow + +Use [Ruff](https://docs.astral.sh/ruff/) locally through `uv` so lint and format checks are consistent for contributors. + +1. Lint check: `uv run ruff check .` +2. Apply safe lint fixes: `uv run ruff check . --fix` +3. Format files: `uv run ruff format .` +4. Format check (CI-style): `uv run ruff format --check .` + +Rule-family baseline for this repository is `E`, `F`, `I`, and `UP`, configured in [pyproject.toml](../pyproject.toml). + Suggested instruction policy text: 1. Start with catalog-first discovery.