docs(agents,style): Update agent guidance#3443
Conversation
Updates agent guidance to avoid free-standing functions where possible, and move the "stringly"-typed guidance to the general style guide since it's not just for agents.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Enterprise Run ID: 📒 Files selected for processing (2)
🚧 Files skipped from review as they are similar to previous changes (2)
Summary by CodeRabbit
WalkthroughDocumentation updates revise repository descriptions and technology guidance, then add Rust conventions for enum-based values and type-oriented methods. ChangesDocumentation guidance
Estimated code review effort: 1 (Trivial) | ~3 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
| `ErrorSystem`/`ErrorSubsystem` parts plus a `code`, rendered to the wire string | ||
| in one place. Reserve raw strings for genuinely open-ended values. | ||
|
|
||
| ### Prefer methods over free functions |
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@AGENTS.md`:
- Line 48: Update the repository tree entry for rest-api in AGENTS.md to use the
Unicode branch connector ├── instead of |--, preserving the existing directory
label and formatting consistency.
- Around line 67-69: Update the REST API language/toolchain version in AGENTS.md
from 1.26.5 to 1.26.4, matching the version pinned by rest-api/go.mod and the
REST CI workflows.
In `@STYLE_GUIDE.md`:
- Around line 699-703: Update the “Avoid stringly-typed values” guidance to say
that types should implement Display and FromStr, replacing the wording that says
to derive their string form while preserving the surrounding enum and struct
guidance.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Enterprise
Run ID: 387e5791-1e9f-4800-8724-4e18eb8b7f1b
📒 Files selected for processing (2)
AGENTS.mdSTYLE_GUIDE.md
|
need re-review @thossain-nv @wminckler when you get a sec |
🔍 Container Scan Summary
Per-CVE detail lives in the per-service |
Updates agent guidance to avoid free-standing functions where possible (so code is more organized and you can see all the functions that impact a model easier), and move the "stringly"-typed guidance to the general style guide since it's not just for agents.
Type of Change
Breaking Changes
Testing
Additional Notes