docs: restructure agent instruction files#2453
Conversation
…structure Co-Authored-By: Claude Sonnet 4.6 <[email protected]>
… PR comments Co-Authored-By: Claude Sonnet 4.6 <[email protected]>
There was a problem hiding this comment.
Code Review
This pull request updates the repository's AI agent guidelines and documentation. It introduces new rules for root cause analysis and minimal scope in the Cursor rules, adds a verification gate requiring test evidence in the skill documentation, and completely restructures AGENTS.md and CLAUDE.md to provide clearer workflow orchestration for autonomous and interactive agents. A new lessons.md file is also created to track process improvements. The review feedback correctly identifies inconsistent file paths for the task management documentation and suggests including critical operational warnings about using uv run in the Claude-specific guide to ensure consistency and prevent execution failures.
|
|
||
| ## Task Management | ||
| 1. Plan First — write plan to tasks/todo.md | ||
| 2. Verify Plan — review before starting; proceed if unambiguous |
There was a problem hiding this comment.
The path to the todo file is inconsistent with other references in this file (lines 12 and 33). It should be updated to tasks/todo.md to ensure clarity for automated agents.
| 2. Verify Plan — review before starting; proceed if unambiguous | |
| 5. Document Results — add review section to tasks/todo.md |
| **Find the root cause.** No band-aids. If a symptom has an underlying cause, address that — not the symptom. | ||
|
|
||
| **Only touch what's necessary.** No side effects. Leave every file you didn't need to change exactly as you found it. | ||
| giskard-oss — behavioral config for Claude Code (interactive assistant with a human in the loop). |
There was a problem hiding this comment.
The header is missing the link to README.md and the critical warning about using uv run, which are present in AGENTS.md. Including these ensures consistency across agent documentation and prevents operational failures when the assistant attempts to run commands directly.
| giskard-oss — behavioral config for Claude Code (interactive assistant with a human in the loop). | |
| giskard-oss — behavioral config for Claude Code (interactive assistant with a human in the loop). Human-oriented docs: [README.md](README.md). Always invoke Python via uv run — bare python or pytest will fail. |
| 2. Verify Plan — check in before starting | ||
| 3. Track Progress — mark items complete as you go | ||
| 4. Explain Changes — high-level summary at each step | ||
| 5. Document Results — add review section to todo.md |
There was a problem hiding this comment.
Co-Authored-By: Claude Sonnet 4.6 <[email protected]>
Summary
CLAUDE.mdandAGENTS.mdto follow Boris Cherny's recommended CLAUDE.md structure (Workflow Orchestration → Task Management → Core Principles)CLAUDE.mdtargets Claude Code (interactive, human in the loop) with plan mode, subagent strategy, elegance, and verification rulesAGENTS.mdtargets autonomous agents (no human in the loop) — lean, self-contained, setup+commands inside Workflow Orchestrationlessons.mdfor capturing corrected mistakes session by session.cursor/rules/guidelines.mdcwith two new rules: Root Causes No Temporary Fixes, Minimal Scopegiskard-oss-pr-readyskillTest plan
CLAUDE.md— confirm 3 sections, ~50 lines, no operational contentAGENTS.md— confirm 3 sections, ~60 lines, setup+commands inside Workflow Orchestrationlessons.md— confirm terse format.cursor/rules/guidelines.mdc— confirm 5 rules totalAGENTS.md— confirm clarify-before-acting policy covers ambiguous issues, better suggestions, and PR comment disagreements