docs: strengthen git workflow instructions with numbered options#49
docs: strengthen git workflow instructions with numbered options#49marcusquinn wants to merge 1 commit intomainfrom
Conversation
- Add prominent 'MANDATORY: Pre-Edit Git Check' section at top of AGENTS.md - Change branch prompt to use numbered options (1, 2, 3) instead of [Enter] - OpenCode requires typed input, so all options must be numbered - Add explicit 'Do NOT proceed until user replies' instruction - Reference pre-edit check from Critical Rules and Git Workflow sections
|
Warning Rate limit exceeded@marcusquinn has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 7 minutes and 43 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 (1)
Note
|
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 refines the git workflow documentation in 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
|
|
Closing: changes already in main |
There was a problem hiding this comment.
Code Review
This pull request significantly improves the clarity and robustness of the git workflow instructions in AGENTS.md. Centralizing the mandatory pre-edit check and using clear, numbered options is a great enhancement. I have one suggestion to make the instructions even more explicit for an automated agent by detailing the actions for each user choice, which will help prevent any ambiguity in the workflow.
| 3. **Do NOT proceed until user replies with 1, 2, or 3** | ||
| 4. After creating branch, call `session-rename_sync_branch` tool |
There was a problem hiding this comment.
The current linear steps 3 and 4 can be ambiguous for an automated agent. The action to take depends on which of the three options the user selects. Specifically, step 4 only applies to options 1 and 2, and the process for option 2 (using a different branch name) is not fully specified (e.g., prompting for the name). It would be more robust to explicitly outline the procedure for each choice to avoid incorrect behavior, such as attempting to rename the session when staying on main.
| 3. **Do NOT proceed until user replies with 1, 2, or 3** | |
| 4. After creating branch, call `session-rename_sync_branch` tool | |
| 3. **Handle the user's response:** | |
| - **If 1 (Create suggested branch):** Create the branch, then call `session-rename_sync_branch`. | |
| - **If 2 (Use different branch name):** Ask for the new name, create that branch, then call `session-rename_sync_branch`. | |
| - **If 3 (Stay on main):** Acknowledge the choice and proceed on `main`. | |
| 4. **Only after this check is complete, proceed with file edits.** |
Summary
Improve git workflow instructions in AGENTS.md with clearer numbered options for user prompts.
Changes