docs: improve CLAUDE.md with governance, local dev, observability, and ADR sections#1210
Conversation
…d ADR sections Add several sections that were missing from CLAUDE.md but documented elsewhere in the repository: - Governance & Agent Guidelines: consolidate agent rules from amber.md/constitution.md, document the layered docs system (context files, patterns, skills, commands), and provide a quick-reference table of governance documents - Architecture Decisions: reference all ADRs in docs/internal/adr/ - Local Development: prerequisites and quick-start commands from CONTRIBUTING.md - Observability: pointers to Langfuse and Grafana docs - Cross-references to .claude/context/, .claude/patterns/, and .claude/skills/ so agents discover them No content was removed — all original sections are preserved and the file remains a single-file overview that fits in context windows.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughDocumentation expansion to CLAUDE.md covering AI agent governance rules, local development setup guidance, observability references, and command example formatting adjustments. Adds prerequisites, Kubernetes troubleshooting, mandatory agent constraints, and links to supporting architecture/observability docs. Changes
🚥 Pre-merge checks | ✅ 6✅ Passed checks (6 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
✨ Simplify code
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 |
|
Closing per request — this was a test PR. |
Summary
Improves
CLAUDE.mdby adding several sections that were missing but documented elsewhere in the repository. All original content is preserved.What's Added
Governance & Agent Guidelines
CLAUDE.md,CONTRIBUTING.md,BOOKMARKS.md,.claude/context/,.claude/patterns/,.claude/skills/,.claude/commands/, and.claude/amber-config.ymlamber.mdandconstitution.md: user-scoped K8s clients, no secret logging, linter requirements, PR size limits, escalation thresholds.claude/context/and.claude/patterns/filesArchitecture Decisions
docs/internal/adr/with one-line descriptionsLocal Development
make kind-up,local-up,local-down, etc.)Observability
Stats
Motivation
CLAUDE.mdis loaded into AI agent context windows. Having governance rules, local dev setup, and architectural context directly in this file means agents start with better guidance — reducing hallucination, improving code quality, and avoiding common mistakes (e.g., using service account clients instead of user-scoped clients).Created via Ship Help Bot at the request of a team member.
Summary by CodeRabbit