docs: document source-of-truth pointers and the CI completion gate#37
Closed
ChasLui wants to merge 1 commit into
Closed
docs: document source-of-truth pointers and the CI completion gate#37ChasLui wants to merge 1 commit into
ChasLui wants to merge 1 commit into
Conversation
Extend AGENTS.md so a new contributor (or coding agent) knows, without reading CI config, what the authoritative references are and exactly which checks must pass before a change is considered done: - Source of truth: point to CODING_STANDARDS.md (conventions) and docs/architecture.md (layered request flow / module map). - Task completion: spell out the same gate enforced by .github/workflows/rust-checks.yml (fmt, check, clippy, test, check_code_size.py with its 300-line / 50-LOC limits). Also ignore /vendor/ so a local 'cargo vendor' never shows up as untracked noise.
ishaan-berri
approved these changes
Jun 9, 2026
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
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.
What
Two small additions to
AGENTS.md, plus a.gitignoreentry. Docs/config only — no code changes.AGENTS.mdCODING_STANDARDS.mdfor conventions anddocs/architecture.mdfor the layered request flow / module map..github/workflows/rust-checks.ymlalready enforces, so you can run it locally before pushing:.gitignore/vendor/so a localcargo vendordoesn't show up as untracked noise.Why
New contributors currently have to read the CI workflow to learn what "done" means and where the conventions live. This writes that down where they'll look first. The commands are copied verbatim from the existing workflow, so there's nothing new to maintain — it just mirrors what CI already checks.
Notes
scripts/check_code_size.pyas of this branch.