Complete agent specs and audit documentation standards#581
Conversation
|
Warning Review limit reached
More reviews will be available in 27 minutes and 46 seconds. Learn how PR review limits work. Your organization has run out of usage credits. Purchase more in the billing tab. ⌛ How to resolve this issue?After more reviews become available, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans include higher PR review limits than trial, open-source, and free plans. In all cases, reviews become available again over time. During sustained high-volume PR review activity, CodeRabbit may temporarily slow when the next review becomes available. Please see our Fair Usage Limits Policy for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Repository YAML (base), Organization UI (inherited) Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (4)
✨ 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 |
github-actions
Bot
added
area:documentation
🔍 Reviewer Summary for PR #581CI Status: ✅ Recommendations
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request establishes comprehensive organization-wide standards by expanding and activating several instruction and specification files, including templates for agents, copilot operations, file organization, multi-platform skill manifests, self-explanatory commenting, spec-driven workflows, task implementation, and WordPress project planning. The review feedback identifies two issues: a reference to a document in the docs directory needs to be updated to uppercase with underscores (AGENT_DEVELOPMENT.md) to comply with the newly defined file organization standards, and an incorrect path to coding-standards.instructions.md in the copilot operations guide needs to be corrected.
| ## See Also | ||
|
|
||
| - [Agents Directory](./README.md) – Directory of all agent specifications | ||
| - [Agent Development Guide](../docs/agent-development.md) – Building and testing new agents |
There was a problem hiding this comment.
According to the repository's file organization standards, documentation and governance files in the docs/ directory must use UPPERCASE naming with underscores (e.g., MIGRATION.md). Please update the reference to agent-development.md to use the uppercase naming convention.
| - [Agent Development Guide](../docs/agent-development.md) – Building and testing new agents | |
| - [Agent Development Guide](../docs/AGENT_DEVELOPMENT.md) – Building and testing new agents |
References
- Documentation and governance files in the
docs/directory must use UPPERCASE naming with underscores (e.g.,GOVERNANCE_REVISION_LOG.md), as the lowercase-with-hyphens naming convention applies to other asset types and not todocs/files.
|
|
||
| ### Session Start Protocol | ||
|
|
||
| 1. **Load context:** Read CLAUDE.md, AGENTS.md, .github/instructions/coding-standards.instructions.md |
There was a problem hiding this comment.
The path to the coding standards instruction file is incorrect. coding-standards.instructions.md is an organization-wide instruction file located in the top-level instructions/ directory, not under .github/instructions/. Please update the path to instructions/coding-standards.instructions.md.
| 1. **Load context:** Read CLAUDE.md, AGENTS.md, .github/instructions/coding-standards.instructions.md | |
| 1. **Load context:** Read CLAUDE.md, AGENTS.md, instructions/coding-standards.instructions.md |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 2faab23a4d
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| ## See Also | ||
|
|
||
| - [Agents Directory](./README.md) – Directory of all agent specifications | ||
| - [Agent Development Guide](../docs/agent-development.md) – Building and testing new agents |
There was a problem hiding this comment.
This newly added See Also entry resolves to docs/agent-development.md, but that file does not exist in the repository (I checked the tree excluding node_modules). Because this template is the canonical starting point for creating agent specs, the broken link leaves new agent authors without the promised build/testing guidance.
Useful? React with 👍 / 👎.
| - [Test Fixer Agent](./test-fixer.agent.md) – Fixes identified test failures | ||
| - [Release Agent](./release.agent.md) – Ensures tests pass before release | ||
| - [CI/CD Integration](../workflows/ci.md) – Runs tests automatically on PR |
There was a problem hiding this comment.
When readers follow these Related Agents links, ./test-fixer.agent.md and ../workflows/ci.md both resolve to missing files in this checkout (repo-wide search excluding node_modules finds neither target). This section documents the Testing Agent's handoff and CI context, so the broken links make that navigation unusable for the scenarios the spec is trying to support.
Useful? React with 👍 / 👎.
Standardise markdown formatting across all instruction files per markdownlint-cli2 rules. https://claude.ai/code/session_015QNP4SGYZTmRmXNQachTTf
Bump versions from v1.0 to v1.1 for files modified after initial documentation: - instructions/file-organisation.instructions.md (added MIGRATION.md references) - instructions/spec-driven-workflow.instructions.md (added breaking changes guidance) Fixes frontmatter freshness validation failure. https://claude.ai/code/session_015QNP4SGYZTmRmXNQachTTf
…entation - Document template.agent.md with canonical specification structure, usage guidelines, and best practices (Issue #488) - Enhance testing.agent.md with comprehensive role, capabilities, configuration, and examples (Issue #490) - Both agents now fully documented with clear responsibilities, tools, constraints, and related references https://claude.ai/code/session_015QNP4SGYZTmRmXNQachTTf
ashleyshaw
force-pushed
the
claude/gracious-edison-ACzNn
branch
from
b6bc1b9 to
15a9c3a
Compare
- Update agent-development.md reference to AGENT_CREATION.md in agents/template.agent.md (correct file exists) - Fix coding-standards.instructions.md path from .github/instructions/ to instructions/ (correct location per file org standards) - Remove broken links to non-existent test-fixer.agent.md and ci.md in agents/testing.agent.md https://claude.ai/code/session_015QNP4SGYZTmRmXNQachTTf
🔍 Reviewer Summary for PR #581CI Status: ✅ Recommendations
|
🔍 Reviewer Summary for PR #581CI Status: ✅ Recommendations
|
2 participants
Summary
Complete documentation for two spec-only agent tracking issues and audit documentation standards for consistency across repository.
Changes Made
Agent Specifications (#488, #490):
template.agent.mdwith full specification template, usage guidelines, structure documentation, and best practicestesting.agent.mdwith comprehensive role/responsibilities, capabilities, configuration, examples, and related agent referencesDocumentation Audit (#22, #18, #21):
Issues Closed
Testing
All validation checks pass:
Checklist
Generated by Claude Code