Repository navigation
docs: document CI efficiency expectations for agents - #4404
Yuxin-Qiao wants to merge 1 commit into
Conversation
|
🦞👀 Pull request received. I will update this pull request when review starts. ClawSweeper review completeClawSweeper finished reviewing this revision. The review result is being finalized. |
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
|
Codex review: needs maintainer review before merge. What this changesThis PR documents how agents should preserve incremental builds, retain required checks, and substantiate CI performance claims. Example: An agent prepares a handoff for head 1ea3f1a after successful hosted validation.
Review scores
ProductKind: Docs · Worth it: Yes · Fix scope: Complete Merge readiness✅ Ready for maintainer review This PR adds useful guidance consistent with current CI safeguards, with no actionable patch defects; repository policy does not permit closing it. Priority: P3 Before mergeNone. FindingsNone. Agent review detailsHow this fits togetherRoot contributor instructions guide development agents from change inspection through local validation and handoff; existing workflow and cache scripts continue to determine CI execution. flowchart TD
A[Development task] --> B[Root agent instructions]
B --> C[Inspect change and CI contracts]
C --> D[Focused validation]
D --> E[Required final checks]
E --> F[Evidence based handoff]
Technical reviewBest possible solution: Land the focused guidance while preserving existing CI gates, cache safeguards and required validation. Do we have a high-confidence way to reproduce the issue? This is a documentation improvement; the recorded handoff demonstrates the intended agent behavior rather than reproducing an application defect. Is this the best way to solve the issue? The root instructions are the appropriate location, and the addition preserves required checks while clarifying when repetition and performance experiments are justified. AGENTS.md: found and applied where relevant. Codex review notes: model internal, reasoning medium; reviewed against c2f22ccf8751. Provenance checked
TestingProof path: shipped entry point. SecurityNone. EvidenceWhat I checked:
Likely related people:
Review metrics
LabelsLabel changes:
Label justifications:
Rating scale6/6 🦀 challenger crab · 5/6 🦞 diamond lobster · 4/6 🐚 platinum hermit · 3/6 🦐 gold shrimp · 2/6 🦪 silver shellfish · 1/6 🧂 unranked krab. Overall follows the weaker of proof and patch quality; ✨ marks media proof (a screenshot, video, or linked artifact) that directly shows the changed behavior. WorkflowClawSweeper edits this one comment on every review. Comment HistoryReview history (1 earlier review cycle)
Reviewed October 10, 2026, 3:40 AM ET / 07:40 UTC (Revision 2). |
Agent instructions require full checks but do not explain how to preserve verified incremental builds or avoid repeating expensive validation on unchanged code. Add a CI Efficiency section to
AGENTS.mdthat asks contributors to assess cache/job impact, retain required coverage and cache safeguards, and report measured results separately from predictions.The guidance keeps required checks intact and reserves repeated cold/warm and multi-toolchain proof experiments for relevant changes. It does not change workflows or claim a runtime speedup.
Real agent behavior proof
An actual Codex CLI agent completed the developer handoff for this PR at head
1ea3f1af7c59205fc45a22a879da1071e3a8ba31. Its task permitted justified local validation and asked it to decide what additional checks were needed; the prompt did not prescribe skipping full tests. The agent read the modified root instructions, inspected CI/cache/path-gate code, independently matched the downloaded results against live GitHub, and appliedAGENTS.md:35to retain successful full-suite evidence without starting another full run solely for reporting.Recorded session and provenance · Actual terminal events · Agent handoff · Task prompt
Actual local terminal results in the recorded session:
The agent process exited 0; all 20 shell commands succeeded. The public derivative retains 17 command events and the agent's decisions; three private-memory command events, local/session identifiers and usage metadata are omitted, and long output excerpts are explicitly marked. Originals are preserved locally. The evidence documents live on a separate fork branch, leaving this PR's diff at one file, +10 lines.
Scope: this is one real handoff task after completed CI, not a controlled before/after prompt study, a new local full-suite run, or a guarantee about future agent behavior. No tracked files, gates or cache safeguards were changed by the agent session, and it made no measurable speedup claim.
Validation
CIrun 38022055294, attempt 1 passed for the reviewed PR head: lint, macOS full discovered inventory, plugin engine A/B goldens, Swift 6.2 compatibility build, both Linux glibc lanes and the aggregate check. GitGuardian passed separately. Musl and main-only cache pruning were skipped by existing policy.AGENTS.mdis outside compiled-cache context inputs; this edit changes no workflow or cache implementation.