Skip to content

docs: document source-of-truth pointers and the CI completion gate#37

Closed
ChasLui wants to merge 1 commit into
LiteLLM-Labs:mainfrom
ChasLui:docs-agent-onboarding-ci-gate
Closed

docs: document source-of-truth pointers and the CI completion gate#37
ChasLui wants to merge 1 commit into
LiteLLM-Labs:mainfrom
ChasLui:docs-agent-onboarding-ci-gate

Conversation

@ChasLui

@ChasLui ChasLui commented Jun 7, 2026

Copy link
Copy Markdown

What

Two small additions to AGENTS.md, plus a .gitignore entry. Docs/config only — no code changes.

AGENTS.md

  • Source of truth — points contributors (and coding agents) at the authoritative references up front: CODING_STANDARDS.md for conventions and docs/architecture.md for the layered request flow / module map.
  • Task completion — spells out the exact gate that .github/workflows/rust-checks.yml already enforces, so you can run it locally before pushing:
    cargo fmt --all --check
    cargo check --all-targets --locked
    cargo clippy --all-targets --locked -- -D warnings
    cargo test --locked
    python3 scripts/check_code_size.py   # ≤300 lines/file, ≤50 LOC/function

.gitignore

  • Ignore /vendor/ so a local cargo vendor doesn'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

  • No source, behavior, or dependency changes.
  • Limits (300 lines/file, 50 LOC/function) match scripts/check_code_size.py as of this branch.

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.
@ChasLui ChasLui closed this Jun 10, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants