-
Notifications
You must be signed in to change notification settings - Fork 37
docs: adopt AGENTS.md standard for agent instructions #366
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
This comment has been minimized.
This comment has been minimized.
1fcac65 to
c2aeb50
Compare
|
OK yeah, man there's a ton of hardcoded references. I guess we may as well try to go a little bit farther here, but if folks feel differently I'm happy to just do the symlink effectively. |
Claude Code ReviewSummaryThis PR successfully renames Overall Assessment: ✅ Approve with one minor issue to address The PR demonstrates excellent attention to detail with systematic updates across the entire codebase. The symlink approach ensures backward compatibility for any external tools or scripts that might reference the old filename. Issues by Severity🟡 Major Issues1. Broken pyproject.toml readme reference
🔵 Minor Issues1. Opportunity for consistency in file header
2. Note about Claude Code coupling could be clearer
Positive Highlights✅ Comprehensive coverage - All 68 references to CLAUDE.md were successfully updated across 25 files ✅ Backward compatibility - Symlink at ✅ Systematic approach - Updated references in:
✅ Clear migration intent - The PR description clearly states motivation (supporting multiple agentic systems) ✅ Documentation updates - Authority hierarchy sections properly updated to show AGENTS.md as the standard ✅ No breaking changes - All functional behavior preserved through this refactoring RecommendationsMust Fix Before Merge
Nice to Have
Future Work (Out of Scope)
Code Quality AssessmentDocumentation: ✅ Excellent - comprehensive updates across all doc files Configuration: ✅ Good - all YAML configs properly updated Testing: Git Hygiene: ✅ Good - clean commit message following conventional commits Following AGENTS.md Standards: ✅ Yes - ironic but appropriate given the PR content Recommendation: Request changes to fix the pyproject.toml issue, then approve. The rest of the PR is high quality and ready to merge once that's addressed. |
haha |
|
symlink should be fine |
c2aeb50 to
0807130
Compare
Claude Code ReviewSummaryThis PR successfully adopts the AGENTS.md community standard by renaming CLAUDE.md to AGENTS.md. The change is well-executed with comprehensive updates across 26 files, maintaining backward compatibility through a symlink at Overall Assessment: ✅ Approved with Minor Suggestions The implementation is solid, thorough, and maintains both technical correctness and backward compatibility. No blocking issues identified. Issues by Severity🔵 Minor Issues1. Missing README in claude-code-runner package
[project]
name = "claude-code-runner"
version = "0.1.0"
description = "Runner that streams via Claude Code SDK and syncs workspace via PVC proxy"
# readme field removed - could add: readme = "../../AGENTS.md"2. Incomplete note about Claude Code hardcoding
Suggested Enhancement: > **Note:** At the current time, specific components are coupled to Claude Code:
> - Runner implementation (components/runners/claude-code-runner/)
> - Agent personas referencing Claude Code workflows
> - CI/CD workflows (.github/workflows/claude*.yml)
>
> Decoupling these components is a future enhancement. This AGENTS.md adoption is the first step.Positive Highlights✅ Excellent Backward Compatibility Strategy
✅ Comprehensive Update Coverage
✅ Proper Header and Metadata
✅ Configuration File Updates
✅ Documentation Consistency
✅ Clear PR Description
RecommendationsImmediate (Optional)
Future Enhancements
Code Quality AssessmentDocumentation: ⭐⭐⭐⭐⭐ (5/5)
Testing: ⭐⭐⭐⭐ (4/5)
Architecture: ⭐⭐⭐⭐⭐ (5/5)
Security: ⭐⭐⭐⭐⭐ (5/5)
Performance: N/A
Standards Compliance✅ AGENTS.md Convention: Properly implements the agents.md standard ConclusionThis is a well-executed refactoring that achieves its stated goals:
The PR is ready to merge. The minor suggestions above are optional enhancements that could be addressed in follow-up work. Recommendation: Approve and merge ✅ |
|
I think symlink should be enough. I don't think there is need to change the reference in the other files |
0807130 to
c60f628
Compare
Claude Code ReviewSummaryThis PR successfully adopts the community AGENTS.md standard by renaming CLAUDE.md to AGENTS.md and updating all references throughout the codebase. The changes are comprehensive, well-executed, and ready to merge. This is a purely documentation/naming refactor with no functional changes to the codebase. The PR demonstrates excellent attention to detail with 26 files updated consistently, maintaining backward compatibility through a symlink, and preserving all functionality while improving discoverability and multi-agent support. Issues by Severity🔵 Minor Issues
Positive Highlights✅ Exceptional Coverage: All 26 files updated consistently - no missed references
✅ Backward Compatibility: Smart use of symlink (.claude/CLAUDE.md → ../AGENTS.md)
✅ Clear Intent in Documentation: Updated content clearly explains the transition
✅ Consistency in Workflow Files: GitHub Actions workflows updated properly
✅ Configuration Alignment: .claude/amber-config.yml correctly updated
✅ Issue Template Updates: Both issue templates updated for consistency
✅ Documentation Depth: Multiple doc categories updated
✅ Agent Persona Updates: agents/amber.md comprehensively updated
RecommendationsPriority 1 (Before Merge)
Priority 2 (Nice to Have)
Priority 3 (Future Work)
Security, Performance, Testing✅ Security: No security implications - purely documentation changes ConclusionThis is a high-quality refactoring PR that successfully standardizes agent instructions following community conventions. The only blocking issue is the minor pyproject.toml fix. Once addressed, this PR is ready to merge. Estimated effort to address issues: < 5 minutes (single line addition) Great work on the comprehensive and consistent updates! This sets a strong foundation for future multi-agent support. 🎉 |
|
I rebased 🏄 - @jeremyeder mind reviewing? |
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
c60f628 to
04ef47b
Compare
Claude Code ReviewSummaryThis PR implements a strategic shift to adopt the community-standard AGENTS.md convention (https://agents.md/) instead of the Claude Code-specific CLAUDE.md. The changes are documentation-only with no functional code modifications. The rename aligns with the project's stated goal of supporting multiple agentic systems beyond Claude Code. Key Changes:
Issues by Severity🚫 Blocker IssuesNone - This PR is safe to merge. 🔴 Critical IssuesNone - All changes follow proper patterns. 🟡 Major IssuesNone - Documentation changes are comprehensive and consistent. 🔵 Minor Issues1. Removed pyproject.toml readme reference without replacementFile: -readme = "CLAUDE.md"
+# (no readme field)Issue: The Recommendation: readme = "README.md" # Use component-specific READMEOr add a simple README.md in the component directory if one doesn't exist. 2. Missing update to .specify directory contextFiles not checked in PR:
Recommendation: Run a comprehensive grep to ensure all references are updated: grep -r "CLAUDE\.md" .specify/ --exclude-dir=.gitPositive Highlights✅ Excellent backward compatibility: The symlink approach ( ✅ Comprehensive reference updates: All 26 modified files maintain consistency with proper CLAUDE.md → AGENTS.md updates. ✅ Clear transitional messaging: The note in AGENTS.md acknowledges current Claude Code coupling:
✅ Constitutional compliance: Authority hierarchy properly updated (Constitution → AGENTS.md → Agent Persona → User Instructions). ✅ No functional changes: This is a pure documentation refactor with zero risk to runtime behavior. ✅ Workflow integrity maintained: All GitHub Actions workflows updated consistently, including critical Amber automation. ✅ Strategic vision: Aligns with community standards and prepares for multi-agent support (Gemini CLI, Goose, etc.). RecommendationsPriority: Low (Non-blocking)
ConclusionVerdict: ✅ APPROVED - Recommend merge This is a well-executed documentation refactor that:
The minor issues identified are non-blocking refinements that can be addressed in follow-up commits if desired. Estimated Risk: VERY LOW - Pure documentation change with backward compatibility. Reviewed by: Claude Code (Sonnet 4.5) |
Rename CLAUDE.md to AGENTS.md to align with the community AGENTS.md convention (https://agents.md/). This standardized format makes the repository's agent instructions more discoverable and consistent with other projects using AI coding assistants. My real motivation here is I want to support other agentic systems and not having this project hardcoded to Claude Code, which is proprietary software. Assisted-by: Claude Code (Sonnet 4.5) Signed-off-by: Colin Walters <walters@verbum.org>
04ef47b to
d7f3fe6
Compare
Claude Code ReviewSummaryThis PR adopts the community-standard AGENTS.md convention for agent instructions while maintaining backward compatibility through symlinks. The change is well-executed with comprehensive updates across all references. The PR represents a strategic move toward supporting multiple agentic systems beyond Claude Code, aligning with the platform's goal of becoming AI-system agnostic. Overall Assessment: ✅ Approved for merge - This is a clean refactoring with no functional changes, excellent backward compatibility, and consistent updates throughout the codebase. Issues by Severity🚫 Blocker IssuesNone. 🔴 Critical IssuesNone. 🟡 Major IssuesNone. 🔵 Minor Issues1. Python dependency cleanup inconsistency
Positive Highlights1. Excellent Backward Compatibility Strategy ✅
2. Comprehensive Reference Updates ✅
3. Strategic Alignment with Community Standards ✅
4. Proper Documentation of Intent ✅
5. Consistent Message Throughout ✅
Architecture ReviewFile Structure ChangesBefore: After: This inversion is correct because:
Impact on Memory SystemThe memory system references remain valid:
No breakage in the structured memory system ✅ Testing VerificationManual Testing Performed# Verified symlink structure
ls -la AGENTS.md CLAUDE.md .claude/CLAUDE.md
# Results: All symlinks correctly point to AGENTS.mdRecommended Additional Testing
Code Quality ChecklistFollowing AGENTS.md standards (ironic, I know):
Security ReviewNo security implications:
Performance ImpactZero performance impact - This is purely a documentation/configuration refactoring. RecommendationsPriority 1: Before Merge
Priority 2: Post-Merge Follow-up
Priority 3: Long-term Strategic
Final Verdict✅ APPROVED - This PR is ready to merge. Why approve:
Minor action items:
Great work on:
Reviewed by: Claude Code (Sonnet 4.5) 🔍 View AI decision process (logs available for 90 days) 📋 View memory system files loaded (click to expand)What Amber Loaded for Code ReviewAmber automatically loaded these repository standards from the memory system:
Impact: This review used your repository's specific code quality standards, security patterns, and best practices from the memory system (PRs #359, #360) - not just generic code review guidelines. |
|
fixed via #429 |
|
There's a subtle but important difference between the two: this PR was trying to start the ball rolling on not having everything be about Claude Code in this repository. But we can debate that here #431 And if that issue is accepted, then I think it would make sense to have CLAUDE.md be the symlink to AGENTS.md, not the other way around. |
Rename CLAUDE.md to AGENTS.md to align with the community AGENTS.md convention (https://agents.md/). This standardized format makes the repository's agent instructions more discoverable and consistent with other projects using AI coding assistants.
My real motivation here is I want to support other agentic systems and not having this project hardcoded to Claude Code, which is proprietary software.
Assisted-by: Claude Code (Sonnet 4.5)