docs: improve agent instructions based on session review#31
docs: improve agent instructions based on session review#31marcusquinn merged 2 commits intomainfrom
Conversation
- AGENTS.md: Clarify worktree as default choice for branch creation - preflight.md: Add worktree awareness section - preflight.md: Add pre-existing vs new issues guidance These improvements address patterns observed during the postflight fixes session where worktree wasn't used by default and preflight loop couldn't distinguish pre-existing issues from new ones.
|
Warning Rate limit exceeded@marcusquinn has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 15 minutes and 8 seconds before requesting another review. ⌛ 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. 📒 Files selected for processing (3)
WalkthroughDocumentation enhancements to branch creation guidance in AGENTS.md with clearer worktree vs checkout labeling, and new preflight.md sections explaining worktree awareness during checks and guidance for handling pre-existing versus newly-introduced issues. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. 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 |
Summary of ChangesHello @marcusquinn, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request enhances the documentation for agent instructions and the preflight workflow. It provides clearer guidance on using Git worktrees for branch creation and introduces a structured approach to managing code quality issues identified during preflight checks, particularly distinguishing between new and pre-existing problems. These updates aim to streamline agent operations and improve the efficiency of code review processes by addressing common pitfalls observed in recent sessions. Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
🔍 Code Quality Report�[0;35m[MONITOR]�[0m Code Review Monitoring Report �[0;34m[INFO]�[0m Latest Quality Status: �[0;34m[INFO]�[0m Recent monitoring activity: 📈 Current Quality Metrics
Generated on: Sun Jan 11 02:22:44 UTC 2026 Generated by AI DevOps Framework Code Review Monitoring |
![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 significantly improves the agent instructions, providing much-needed clarity on branching strategies and handling pre-existing issues during preflight checks. The updates to AGENTS.md correctly emphasize worktrees as the preferred method, and the new sections in preflight.md offer excellent, practical guidance for developers. I have one minor suggestion to make a shell command example more robust. Overall, these are valuable documentation enhancements.
| git diff main --name-only | ||
|
|
||
| # Check issues only in your changed files | ||
| shellcheck $(git diff main --name-only -- '*.sh') |
There was a problem hiding this comment.
The shellcheck $(...) command is not robust as it will fail for filenames containing spaces or other special characters due to shell word splitting. A more robust method is to use NUL-delimited output from git diff with the -z flag and pipe it to xargs -0, which is designed to handle all possible filenames correctly.
| shellcheck $(git diff main --name-only -- '*.sh') | |
| git diff main --name-only -z -- '*.sh' | xargs -0 shellcheck |
🤖 Augment PR SummarySummary: This PR refines agent documentation to prevent common workflow pitfalls observed during the postflight fixes session. Changes:
Technical Notes: Emphasizes focusing remediation on violations introduced by the PR and documenting inherited issues for follow-up cleanup. 🤖 Was this summary useful? React with 👍 or 👎 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
![augmentcode[bot]](https://avatars.githubusercontent.com/in/1027498?s=60&v=4){kind=small}
| .agent/scripts/version-manager.sh bump patch | ||
| ```text | ||
|
|
||
| ## Worktree Awareness |
There was a problem hiding this comment.
## Worktree Awareness (and the rest of this new section) appears to follow a fenced block that’s closed with text rather than a bare , which can cause everything after to render as a code block in Markdown. Worth double-checking the fence closures in this area so the new headings/sections render correctly.
🤖 Was this useful? React with 👍 or 👎
| git diff main --name-only | ||
|
|
||
| # Check issues only in your changed files | ||
| shellcheck $(git diff main --name-only -- '*.sh') |
There was a problem hiding this comment.
The example shellcheck $(git diff main --name-only -- '*.sh') can behave unexpectedly if there are no matching files or if any filenames contain spaces. Consider adding a short note/caveat so readers don’t get tripped up by the command substitution.
🤖 Was this useful? React with 👍 or 👎
- Add tool-level pre-edit enforcement reminder in AGENTS.md - Add worktree deletion recovery section in worktree.md - Add PR loop timeout guidance in pr.md Based on agent-review analysis of session where pre-edit check was missed.
|
🔍 Code Quality Report�[0;35m[MONITOR]�[0m Code Review Monitoring Report �[0;34m[INFO]�[0m Latest Quality Status: �[0;34m[INFO]�[0m Recent monitoring activity: 📈 Current Quality Metrics
Generated on: Sun Jan 11 02:29:15 UTC 2026 Generated by AI DevOps Framework Code Review Monitoring |
1 participant
Summary
Improvements to agent instructions based on patterns observed during the postflight fixes session (#30).
Changes
AGENTS.md
workflows/preflight.md
Context
During the postflight fixes session:
git checkout -binstead of worktree - user had to correctThese improvements address all three patterns.
Summary by CodeRabbit
✏️ Tip: You can customize this high-level summary in your review settings.