docs/config: sync gate docs to check.sh; expand agent allowlist#28
Merged
Conversation
The `check` skill and AGENTS.md described an older, shorter gate (ruff + mypy + markdownlint + shellcheck + pytest + build) and omitted the stages that most often surprise an otherwise-clean change: pyright, vulture, deptry, import-linter, xenon, prettier, diff-cover, and the escape-hatch diff gate. Both now mirror scripts/check.sh in order, with a short note on what the non-obvious gates enforce. Also: - AGENTS.md: document the syrupy snapshot tests + `pytest --snapshot-update` regen flow (the auto-format hook only touches *.py). - settings.json: allowlist the gate tools an agent may run bare (pyright, vulture, deptry, lint-imports, xenon, diff-cover, prettier, swiftlint) and the read-only GitHub MCP tools used in web sessions; keep the `gh` entries for local contributors. - check.sh: give prettier the same skip-if-missing guard shellcheck/swiftlint already have, so the full gate no longer hard-fails on a container without prettier on PATH.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The
checkskill and AGENTS.md described an older, shorter gate (ruff +mypy + markdownlint + shellcheck + pytest + build) and omitted the stages
that most often surprise an otherwise-clean change: pyright, vulture,
deptry, import-linter, xenon, prettier, diff-cover, and the escape-hatch
diff gate. Both now mirror scripts/check.sh in order, with a short note on
what the non-obvious gates enforce.
Also:
pytest --snapshot-updateregen flow (the auto-format hook only touches *.py).
vulture, deptry, lint-imports, xenon, diff-cover, prettier, swiftlint) and
the read-only GitHub MCP tools used in web sessions; keep the
ghentriesfor local contributors.
already have, so the full gate no longer hard-fails on a container without
prettier on PATH.