docs: unify AI agent documentation in AGENTS.md#24
Merged
Conversation
|
Note Other AI code review bot(s) detectedCodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review. WalkthroughRemoved two documentation files and consolidated design/testing guidance into a new AGENTS.md; updated references in CONTRIBUTING.md and docs/testing-guidelines.md to point to AGENTS.md (CLAUDE.md retained as a backward-compat symlink). No code or public API changes. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
Poem
Pre-merge checks and finishing touches✅ Passed checks (3 passed)
✨ Finishing touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR consolidates AI assistant documentation by merging all guidance into AGENTS.md, removing redundant files, and creating a symlink for backward compatibility.
- Unified guidance for AI assistants in single AGENTS.md file with comprehensive design decisions and TDD workflow
- Removed redundant documentation files (CLAUDE.md content, development-history.md, copilot-instructions.md)
- Created CLAUDE.md symlink to AGENTS.md for backward compatibility and updated references throughout
Reviewed Changes
Copilot reviewed 6 out of 7 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| docs/testing-guidelines.md | Updated reference from CLAUDE.md to AGENTS.md with symlink note |
| docs/development-history.md | Removed entire file - content consolidated into AGENTS.md |
| CONTRIBUTING.md | Updated reference to mention AGENTS.md as primary with CLAUDE.md as symlink |
| CLAUDE.md | Converted to symlink pointing to AGENTS.md |
| AGENTS.md | Expanded with comprehensive design decisions, TDD workflow, and architecture details |
| .github/copilot-instructions.md | Removed file - guidance moved to AGENTS.md |
Comment on lines
7
to
+8
| > **Note**: For TDD bug fixing examples and architectural decisions, see | ||
| > [CLAUDE.md](../CLAUDE.md). | ||
| > [AGENTS.md](../AGENTS.md) (also available via the `CLAUDE.md` symlink). |
| - Document new features and configuration options | ||
| - Include examples for complex functionality | ||
| - Update CLAUDE.md for design decisions | ||
| - Update AGENTS.md (CLAUDE.md is a symlink for backward compatibility) for design decisions |
There was a problem hiding this comment.
[nitpick] The parenthetical note about the symlink disrupts readability. Consider rephrasing to: 'Update AGENTS.md for design decisions (note: CLAUDE.md is maintained as a symlink for backward compatibility)'
Suggested change
| - Update AGENTS.md (CLAUDE.md is a symlink for backward compatibility) for design decisions | |
| - Update AGENTS.md for design decisions (note: CLAUDE.md is maintained as a symlink for backward compatibility) |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
AGENTS.md (2)
93-97: Promote “Implementation Notes” to a heading.Markdownlint (MD036) warns about using bold text as a pseudo-heading. Swap the emphasis for a proper heading level to keep lint happy.
-**Implementation Notes** +#### Implementation Notes
109-116: Add blank lines around the table.MD058 expects a blank line before and after Markdown tables. Insert the spacing so docs passes lint.
-### User Experience Matrix -| Installation Method | Tab Completion | cd Functionality | +### User Experience Matrix + +| Installation Method | Tab Completion | cd Functionality | |---------------------|----------------|------------------| | Homebrew | Automatic | `eval "$(wtp hook <shell>)"` | | `go install` | `eval "$(wtp completion <shell>)"` | `eval "$(wtp hook <shell>)"` | - -### Migration Notes + +### Migration Notes
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (7)
.github/copilot-instructions.md(0 hunks)AGENTS.md(2 hunks)CLAUDE.md(0 hunks)CLAUDE.md(1 hunks)CONTRIBUTING.md(1 hunks)docs/development-history.md(0 hunks)docs/testing-guidelines.md(1 hunks)
💤 Files with no reviewable changes (2)
- docs/development-history.md
- .github/copilot-instructions.md
🧰 Additional context used
📓 Path-based instructions (3)
CLAUDE.md
📄 CodeRabbit inference engine (AGENTS.md)
Design decisions, TDD workflow, and dev tips are documented in CLAUDE.md
Files:
CLAUDE.md
docs/**/*.md
📄 CodeRabbit inference engine (CLAUDE.md)
Update documentation (including architecture changes and testing guidelines) under docs/ when behavior or design changes
Files:
docs/testing-guidelines.md
docs/**
📄 CodeRabbit inference engine (AGENTS.md)
Project documentation is kept under the docs/ directory
Files:
docs/testing-guidelines.md
🧠 Learnings (16)
📓 Common learnings
Learnt from: CR
PR: satococoa/wtp#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-08-11T13:56:29.054Z
Learning: Reference AGENTS.md for contributor workflow; cite CLAUDE.md for deep design questions
Learnt from: CR
PR: satococoa/wtp#0
File: AGENTS.md:0-0
Timestamp: 2025-09-17T13:46:35.261Z
Learning: Applies to CLAUDE.md : Design decisions, TDD workflow, and dev tips are documented in CLAUDE.md
📚 Learning: 2025-08-11T13:56:29.054Z
Learnt from: CR
PR: satococoa/wtp#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-08-11T13:56:29.054Z
Learning: Reference AGENTS.md for contributor workflow; cite CLAUDE.md for deep design questions
Applied to files:
CONTRIBUTING.mddocs/testing-guidelines.md
📚 Learning: 2025-09-17T13:46:35.261Z
Learnt from: CR
PR: satococoa/wtp#0
File: AGENTS.md:0-0
Timestamp: 2025-09-17T13:46:35.261Z
Learning: Applies to CLAUDE.md : Design decisions, TDD workflow, and dev tips are documented in CLAUDE.md
Applied to files:
CONTRIBUTING.mddocs/testing-guidelines.md
📚 Learning: 2025-09-17T13:46:06.013Z
Learnt from: CR
PR: satococoa/wtp#0
File: CLAUDE.md:0-0
Timestamp: 2025-09-17T13:46:06.013Z
Learning: Applies to README.md : Update README.md with documentation and examples for new features
Applied to files:
CONTRIBUTING.md
📚 Learning: 2025-09-17T13:46:06.013Z
Learnt from: CR
PR: satococoa/wtp#0
File: CLAUDE.md:0-0
Timestamp: 2025-09-17T13:46:06.013Z
Learning: Applies to docs/**/*.md : Update documentation (including architecture changes and testing guidelines) under docs/ when behavior or design changes
Applied to files:
CONTRIBUTING.md
📚 Learning: 2025-09-17T13:46:35.261Z
Learnt from: CR
PR: satococoa/wtp#0
File: AGENTS.md:0-0
Timestamp: 2025-09-17T13:46:35.261Z
Learning: Applies to go.mod : Root Go module path must be github.com/satococoa/wtp
Applied to files:
AGENTS.md
📚 Learning: 2025-09-17T13:46:06.013Z
Learnt from: CR
PR: satococoa/wtp#0
File: CLAUDE.md:0-0
Timestamp: 2025-09-17T13:46:06.013Z
Learning: Applies to **/*_test.go : Keep tests focused: one test per feature/behavior/bug
Applied to files:
AGENTS.md
📚 Learning: 2025-08-11T13:56:29.054Z
Learnt from: CR
PR: satococoa/wtp#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-08-11T13:56:29.054Z
Learning: Applies to **/*_test.go : Write tests as table-driven tests and name test files with *_test.go
Applied to files:
AGENTS.md
📚 Learning: 2025-09-17T13:46:35.261Z
Learnt from: CR
PR: satococoa/wtp#0
File: AGENTS.md:0-0
Timestamp: 2025-09-17T13:46:35.261Z
Learning: Applies to **/*_test.go : Use standard library testing with testify for assertions in tests
Applied to files:
AGENTS.md
📚 Learning: 2025-09-17T13:46:06.013Z
Learnt from: CR
PR: satococoa/wtp#0
File: CLAUDE.md:0-0
Timestamp: 2025-09-17T13:46:06.013Z
Learning: Applies to **/*_test.go : Test behavior, not implementation details; use meaningful assertions
Applied to files:
AGENTS.md
📚 Learning: 2025-09-17T13:46:35.261Z
Learnt from: CR
PR: satococoa/wtp#0
File: AGENTS.md:0-0
Timestamp: 2025-09-17T13:46:35.261Z
Learning: Applies to **/*_test.go : Unit tests are Go *_test.go files colocated with the code; prefer table-driven tests and name test functions TestXxx
Applied to files:
AGENTS.md
📚 Learning: 2025-09-17T13:46:35.261Z
Learnt from: CR
PR: satococoa/wtp#0
File: AGENTS.md:0-0
Timestamp: 2025-09-17T13:46:35.261Z
Learning: Applies to **/*.go : Follow standard Go formatting and idioms (tabs, gofmt); package names are short and lowercase
Applied to files:
AGENTS.md
📚 Learning: 2025-09-17T13:46:06.013Z
Learnt from: CR
PR: satococoa/wtp#0
File: CLAUDE.md:0-0
Timestamp: 2025-09-17T13:46:06.013Z
Learning: Applies to **/*_test.go : Consider edge cases: include boundary conditions and error scenarios in tests
Applied to files:
AGENTS.md
📚 Learning: 2025-09-17T13:46:06.013Z
Learnt from: CR
PR: satococoa/wtp#0
File: CLAUDE.md:0-0
Timestamp: 2025-09-17T13:46:06.013Z
Learning: Applies to cmd/wtp/**/*.go : `wtp hook <shell>` must output a shell function that intercepts `wtp cd` for bash, zsh, and fish
Applied to files:
AGENTS.md
📚 Learning: 2025-09-17T13:46:35.261Z
Learnt from: CR
PR: satococoa/wtp#0
File: AGENTS.md:0-0
Timestamp: 2025-09-17T13:46:35.261Z
Learning: Applies to .wtp.yml : Project hooks are defined in .wtp.yml; keep hook commands deterministic and non-destructive by default
Applied to files:
AGENTS.md
📚 Learning: 2025-09-17T13:46:06.013Z
Learnt from: CR
PR: satococoa/wtp#0
File: CLAUDE.md:0-0
Timestamp: 2025-09-17T13:46:06.013Z
Learning: Applies to cmd/wtp/**/*.go : `wtp shell-init <shell>` should combine completion and hook output for convenient setup
Applied to files:
AGENTS.md
🪛 markdownlint-cli2 (0.18.1)
AGENTS.md
93-93: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
110-110: Tables should be surrounded by blank lines
(MD058, blanks-around-tables)
satococoa
force-pushed
the
codex/unify-ai-agent-documentation-in-agents.md
branch
from
77be55e to
bc5d277
Compare
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
AGENTS.md (2)
93-97: Convert “Implementation Notes” into a proper headingMarkdownlint (MD036) flags the bold text used as a pseudo-heading here. Switching to an actual heading keeps the document lint-clean and consistent with the rest of the guide.
-**Implementation Notes** +### Implementation Notes
109-116: Add blank lines around the table for markdownlint complianceThe table needs blank lines before and after it to satisfy markdownlint rule MD058 and match surrounding section formatting.
### User Experience Matrix -| Installation Method | Tab Completion | cd Functionality | -|---------------------|----------------|------------------| -| Homebrew | Automatic | `eval "$(wtp hook <shell>)"` | -| `go install` | `eval "$(wtp completion <shell>)"` | `eval "$(wtp hook <shell>)"` | + +| Installation Method | Tab Completion | cd Functionality | +|---------------------|----------------|------------------| +| Homebrew | Automatic | `eval "$(wtp hook <shell>)"` | +| `go install` | `eval "$(wtp completion <shell>)"` | `eval "$(wtp hook <shell>)"` | + ### Migration Notes
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (7)
.github/copilot-instructions.md(0 hunks)AGENTS.md(2 hunks)CLAUDE.md(0 hunks)CLAUDE.md(1 hunks)CONTRIBUTING.md(1 hunks)docs/development-history.md(0 hunks)docs/testing-guidelines.md(1 hunks)
💤 Files with no reviewable changes (2)
- docs/development-history.md
- .github/copilot-instructions.md
✅ Files skipped from review due to trivial changes (1)
- CLAUDE.md
🚧 Files skipped from review as they are similar to previous changes (3)
- CLAUDE.md
- CONTRIBUTING.md
- docs/testing-guidelines.md
🧰 Additional context used
🧠 Learnings (13)
📓 Common learnings
Learnt from: CR
PR: satococoa/wtp#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-08-11T13:56:29.054Z
Learning: Reference AGENTS.md for contributor workflow; cite CLAUDE.md for deep design questions
Learnt from: CR
PR: satococoa/wtp#0
File: AGENTS.md:0-0
Timestamp: 2025-09-17T13:46:35.261Z
Learning: Applies to CLAUDE.md : Design decisions, TDD workflow, and dev tips are documented in CLAUDE.md
📚 Learning: 2025-08-11T13:56:29.054Z
Learnt from: CR
PR: satococoa/wtp#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-08-11T13:56:29.054Z
Learning: Reference AGENTS.md for contributor workflow; cite CLAUDE.md for deep design questions
Applied to files:
AGENTS.md
📚 Learning: 2025-09-17T13:46:35.261Z
Learnt from: CR
PR: satococoa/wtp#0
File: AGENTS.md:0-0
Timestamp: 2025-09-17T13:46:35.261Z
Learning: Applies to CLAUDE.md : Design decisions, TDD workflow, and dev tips are documented in CLAUDE.md
Applied to files:
AGENTS.md
📚 Learning: 2025-09-17T13:46:35.261Z
Learnt from: CR
PR: satococoa/wtp#0
File: AGENTS.md:0-0
Timestamp: 2025-09-17T13:46:35.261Z
Learning: Applies to go.mod : Root Go module path must be github.com/satococoa/wtp
Applied to files:
AGENTS.md
📚 Learning: 2025-08-11T13:56:29.054Z
Learnt from: CR
PR: satococoa/wtp#0
File: .github/copilot-instructions.md:0-0
Timestamp: 2025-08-11T13:56:29.054Z
Learning: Applies to **/*_test.go : Write tests as table-driven tests and name test files with *_test.go
Applied to files:
AGENTS.md
📚 Learning: 2025-09-17T13:46:35.261Z
Learnt from: CR
PR: satococoa/wtp#0
File: AGENTS.md:0-0
Timestamp: 2025-09-17T13:46:35.261Z
Learning: Applies to **/*_test.go : Use standard library testing with testify for assertions in tests
Applied to files:
AGENTS.md
📚 Learning: 2025-10-06T16:58:05.857Z
Learnt from: CR
PR: satococoa/wtp#0
File: CLAUDE.md:0-0
Timestamp: 2025-10-06T16:58:05.857Z
Learning: Applies to **/*_test.go : Test behavior, not implementation details
Applied to files:
AGENTS.md
📚 Learning: 2025-09-17T13:46:35.261Z
Learnt from: CR
PR: satococoa/wtp#0
File: AGENTS.md:0-0
Timestamp: 2025-09-17T13:46:35.261Z
Learning: Applies to **/*_test.go : Unit tests are Go *_test.go files colocated with the code; prefer table-driven tests and name test functions TestXxx
Applied to files:
AGENTS.md
📚 Learning: 2025-10-06T16:58:05.857Z
Learnt from: CR
PR: satococoa/wtp#0
File: CLAUDE.md:0-0
Timestamp: 2025-10-06T16:58:05.857Z
Learning: Applies to **/*_test.go : Follow TDD: write a failing test before implementing changes
Applied to files:
AGENTS.md
📚 Learning: 2025-09-17T13:46:35.261Z
Learnt from: CR
PR: satococoa/wtp#0
File: AGENTS.md:0-0
Timestamp: 2025-09-17T13:46:35.261Z
Learning: Applies to **/*.go : Follow standard Go formatting and idioms (tabs, gofmt); package names are short and lowercase
Applied to files:
AGENTS.md
📚 Learning: 2025-10-06T16:58:05.857Z
Learnt from: CR
PR: satococoa/wtp#0
File: CLAUDE.md:0-0
Timestamp: 2025-10-06T16:58:05.857Z
Learning: Applies to **/*_test.go : Keep tests focused: one behavior/feature/bug per test
Applied to files:
AGENTS.md
📚 Learning: 2025-10-06T16:58:05.857Z
Learnt from: CR
PR: satococoa/wtp#0
File: CLAUDE.md:0-0
Timestamp: 2025-10-06T16:58:05.857Z
Learning: Applies to **/*_test.go : Consider edge cases: include boundary conditions and error scenarios in tests
Applied to files:
AGENTS.md
📚 Learning: 2025-09-17T13:46:35.261Z
Learnt from: CR
PR: satococoa/wtp#0
File: AGENTS.md:0-0
Timestamp: 2025-09-17T13:46:35.261Z
Learning: Applies to .wtp.yml : Project hooks are defined in .wtp.yml; keep hook commands deterministic and non-destructive by default
Applied to files:
AGENTS.md
🪛 markdownlint-cli2 (0.18.1)
AGENTS.md
93-93: Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
110-110: Tables should be surrounded by blank lines
(MD058, blanks-around-tables)
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: E2E Tests (macos-latest)
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
1 participant
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.
Summary
Testing
https://chatgpt.com/codex/tasks/task_e_68e3d739af90832781c6f1ca5e8c8256
Summary by CodeRabbit