docs: make AGENTS.md cleaner - #2477
Conversation
![gemini-code-assist[bot]](https://cdn.statically.io/img/avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request restructures the project's behavioral configuration by moving the primary instructions from .claude/CLAUDE.md to AGENTS.md, leaving the original file as a pointer. Feedback focuses on restoring the critical instruction to use uv run for Python execution and updating internal references that still point to CLAUDE.md instead of the new AGENTS.md location.
| # AGENTS.md | ||
|
|
||
| giskard-oss — behavioral config for autonomous coding agents (no human in the loop). Human-oriented docs: [README.md](README.md). Always invoke Python via `uv run` — bare `python` or `pytest` will fail. | ||
| giskard-oss — behavioral config for Claude Code (interactive assistant with a human in the loop). |
There was a problem hiding this comment.
The instruction to use uv run for Python execution was removed in this version. Since the project environment setup relies on uv, omitting this can lead to execution failures when agents or users attempt to run scripts or tests directly. It is recommended to preserve this guidance.
| 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). Always invoke Python via uv run — bare python or pytest will fail. |
| – Show `make check` and pytest summary output in the PR description | ||
| – No `# type: ignore` without structural-fix explanation; no patching test assertions | ||
| ### 3. Self-Improvement Loop | ||
| – After ANY correction: self-document the rule (naming, file headers, examples); only add to CLAUDE.md if it cannot be self-documented |
There was a problem hiding this comment.
The text still refers to CLAUDE.md for adding rules. Since the primary configuration has been moved to AGENTS.md and .claude/CLAUDE.md now acts as a pointer, this reference should be updated to ensure instructions are added to the correct source file.
| – After ANY correction: self-document the rule (naming, file headers, examples); only add to CLAUDE.md if it cannot be self-documented | |
| – After ANY correction: self-document the rule (naming, file headers, examples); only add to AGENTS.md if it cannot be self-documented |
| 5. Document Results — add review section to tasks/todo.md | ||
| 6. Capture Lessons — update lessons.md after corrections | ||
| 5. Document Results — add review section to the plan file | ||
| 6. Capture Lessons — update CLAUDE.md directly after corrections |
There was a problem hiding this comment.
This step directs the user to update CLAUDE.md. Given the new structure where AGENTS.md contains the actual configuration and CLAUDE.md is a pointer, the instruction should be updated to point to AGENTS.md to avoid overwriting the inclusion directive in the other file.
| 6. Capture Lessons — update CLAUDE.md directly after corrections | |
| 6. Capture Lessons — update AGENTS.md directly after corrections |
1 participant
No description provided.