docs(readme): drop the .agents/ multi-tool convention#11
Conversation
Retire the whole "AI-assisted development" block (120 lines across "The convention" / "Why .agents/skills exists" / "AGENTS.md contract" / "Writing a skill" / "Keeping things in sync" / "Supported tools"). That convention required each repo to maintain parallel directories for Claude / Codex / Cursor / Gemini / Copilot, keep AGENTS.md ↔ CLAUDE.md in sync via agent-sync.sh, and manage symlinks from a `.agents/skills/` source of truth. In practice: too much per-repo maintenance and an ever-expanding surface for supply-chain tampering (every agent tool is another directory on disk that could get a malicious rule file). Replacement is a 2-paragraph "Contributor guide" section pointing at: - `AGENTS.md` at the root of each repo — the actual canonical dev guide - Org-level defaults in resq-software/.github: CONTRIBUTING.md, SECURITY.md, CODE_OF_CONDUCT.md (which every public repo now inherits automatically since PR #2 in that repo) README goes from 261 lines to 141. Grep for `.agents/`, `skills`, `CLAUDE`, `Cursor`, `Gemini`, `Codex` in this file → zero hits. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
|
Warning Rate limit exceeded
Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 55 minutes and 16 seconds. ⌛ How to resolve this issue?After the wait time has elapsed, 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 have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ✨ 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 |
![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 simplifies the README.md by replacing the detailed AI-assisted development section with a concise Contributor guide. The new section directs developers to AGENTS.md for repository-specific instructions and links to organization-wide documentation in the .github repository. Review feedback suggests adding an emoji to the new header for visual consistency with other sections and hyperlinking the reference to AGENTS.md to improve navigation.
|
|
||
|
|
||
| ## 🔧 AI-assisted development | ||
| ## Contributor guide |
There was a problem hiding this comment.
The header "Contributor guide" is missing an emoji, which is inconsistent with all other top-level headers in this README (e.g., ## ⚡ Onboarding, ## 📦 Repositories, ## 🛠 Standalone scripts). Adding an emoji like 🤝 would maintain the established visual style of the document.
| ## Contributor guide | |
| ## 🤝 Contributor guide |
| ## Contributor guide | ||
|
|
||
| Every ResQ repo is structured for AI-assisted development. Human developers and AI tools (Claude Code, Cursor, Codex, Gemini, GitHub Copilot) share the same context through a standardized directory layout and canonical guidance files. | ||
| Every ResQ repo ships an `AGENTS.md` at the root — the canonical plain-text dev guide. That's where the build/test/lint commands, architecture notes, and standards for that specific repo live. Read it first. |
There was a problem hiding this comment.
Since AGENTS.md is described as the "canonical plain-text dev guide" and the reader is encouraged to "Read it first", providing a direct link to the file improves navigation for developers exploring the repository.
| Every ResQ repo ships an `AGENTS.md` at the root — the canonical plain-text dev guide. That's where the build/test/lint commands, architecture notes, and standards for that specific repo live. Read it first. | |
| Every ResQ repo ships an [AGENTS.md](./AGENTS.md) at the root — the canonical plain-text dev guide. That's where the build/test/lint commands, architecture notes, and standards for that specific repo live. Read it first. |
1 participant
Summary
Retire the 120-line "AI-assisted development" block in the README that documented the
.agents/skills/+ per-tool-directory (.claude//.codex//.cursor//.gemini//.github/agents/) +agent-sync.shconvention.Per your call: too much per-repo maintenance and an ever-expanding supply-chain surface (each agent tool = another directory that could carry a malicious rule file).
What replaces it
Two paragraphs pointing at:
AGENTS.mdat the root of each repo — the canonical plain-text dev guide (staying).CONTRIBUTING.md/SECURITY.md/CODE_OF_CONDUCT.mdinresq-software/.github, which every public repo inherits automatically since that repo's ci: hooks-sync workflow (shellcheck + drift check vs crates templates) #2 landed.Numbers
.agents|skills|CLAUDE|Cursor|Gemini|Codex→ 0 matchesOut of scope
Actual filesystem deletion of
.claude//.codex//.cursor//.gemini//.agents//agent-sync.shfrom each repo is a separate, mechanical per-repo sweep. Happy to do it as a follow-up, but it's noisy and deserves its own batch — not bundled into a doc PR.🤖 Generated with Claude Code