-
Notifications
You must be signed in to change notification settings - Fork 6
docs: update branch creation to recommend worktrees for parallel sessions #50
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
…ions Update pre-edit-check.sh and AGENTS.md to offer worktree creation as the recommended option for parallel terminal sessions, while keeping traditional checkout as an alternative. - pre-edit-check.sh now shows Option A (worktree) and Option B (checkout) - AGENTS.md prompt updated with 4 options including worktree - References existing worktree-helper.sh and worktree.md workflow This aligns the branch creation guidance with the existing worktree infrastructure that was already in place but not surfaced in the prompts.
|
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 1 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 (2)
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 refines the developer workflow by promoting the use of Git worktrees for managing parallel development tasks. By updating both documentation and a key pre-edit check script, the changes aim to guide developers towards a more efficient and isolated branching strategy, ultimately improving productivity and reducing the risk of conflicts when working on multiple features or fixes concurrently. 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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request updates the branch creation workflow documentation and scripts to recommend using git worktree for parallel development. The changes in AGENTS.md and pre-edit-check.sh are a good improvement. I have a few suggestions to improve the clarity and robustness of the new instructions. Specifically, I'm recommending a clearer structure for the procedural steps in AGENTS.md and addressing a hardcoded path in pre-edit-check.sh that could be brittle.
| 3. **Do NOT proceed until user replies with 1, 2, 3, or 4** | ||
| 4. If worktree (option 1): `~/.aidevops/agents/scripts/worktree-helper.sh add {type}/{name}` | ||
| 5. If checkout (option 2): `git checkout -b {type}/{name}` | ||
| 6. After creating branch, call `session-rename_sync_branch` tool |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This new set of instructions has a couple of areas for improvement:
- The sequential numbering of steps 4, 5, and 6 can be confusing, as steps 4 and 5 are mutually exclusive. It would be clearer to restructure this to show that creating a branch is a single step with different options.
- The placeholder
{name}is used here, butpre-edit-check.shuses{description}. To maintain consistency across the documentation and scripts, it's better to use a single placeholder.{description}seems more descriptive.
Here is a suggested revision that addresses both points:
| 3. **Do NOT proceed until user replies with 1, 2, 3, or 4** | |
| 4. If worktree (option 1): `~/.aidevops/agents/scripts/worktree-helper.sh add {type}/{name}` | |
| 5. If checkout (option 2): `git checkout -b {type}/{name}` | |
| 6. After creating branch, call `session-rename_sync_branch` tool | |
| 3. **Do NOT proceed until user replies with 1, 2, 3, or 4** | |
| 4. After user reply, create the branch: | |
| - If option 1 (worktree): `~/.aidevops/agents/scripts/worktree-helper.sh add {type}/{description}` | |
| - If option 2 (checkout): `git checkout -b {type}/{description}` | |
| 5. After creating branch, call `session-rename_sync_branch` tool |
| echo "" | ||
| echo " Option A - Worktree (recommended for parallel sessions):" | ||
| echo " ~/.aidevops/agents/scripts/worktree-helper.sh add {type}/{description}" | ||
| echo " cd ../{repo}-{type}-{description}" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This line hardcodes the directory naming convention for the new worktree (../{repo}-{type}-{description}). This is brittle because if the worktree-helper.sh script changes its directory naming logic, this instruction will become incorrect. A more robust approach would be for worktree-helper.sh to print the path of the created worktree, and the instructions here would guide the user to cd into that printed path. This would decouple the instruction from the implementation details of the helper script.
… redirect - Move escalate_model_on_failure before attempt_self_heal in DB orphan path for consistency with hung worker path (Gemini high-priority) - Fix comment and log message to accurately reflect auto-upgrade behavior instead of suggesting it's optional (Gemini medium-priority) - Redirect classify_task_complexity stderr to SUPERVISOR_LOG instead of /dev/null per style guide rule #50 (Gemini medium-priority)
…to-upgrade safeguard (#1257) * fix(t320): wire escalate_model_on_failure into retry/hung/orphan paths, improve classifier, add auto-upgrade safeguard - Wire escalate_model_on_failure() (t314) into 3 failure paths where it was defined but never called (dead code): 1. Retry path: escalate before re-prompt so retry uses stronger model 2. Hung worker kill: escalate before self-heal retry 3. DB orphan: escalate before self-heal retry - Improve classify_task_complexity() with 15 new opus-tier patterns: pre-commit hooks, CI checks/workflows, GitHub Actions, edge cases, enforcement, guards, wiring, end-to-end testing, multi-file changes, module extraction, supervisor work, diff/staged parsing - Add pre-check for module-level operations that would otherwise match sonnet-tier extract.*function pattern - Add auto-upgrade safeguard in cmd_add(): when a task has explicit model:sonnet but classify_task_complexity() recommends opus, auto-upgrade to opus with a logged warning. Safety-first: complex tasks should never run on weaker models just because they were manually tagged wrong. * fix: address review feedback — fix ordering, comment accuracy, stderr redirect - Move escalate_model_on_failure before attempt_self_heal in DB orphan path for consistency with hung worker path (Gemini high-priority) - Fix comment and log message to accurately reflect auto-upgrade behavior instead of suggesting it's optional (Gemini medium-priority) - Redirect classify_task_complexity stderr to SUPERVISOR_LOG instead of /dev/null per style guide rule #50 (Gemini medium-priority)
Summary
Update branch creation workflow to recommend worktrees as the default for parallel work.
Changes