[workflow] chore: ignore local worktrees

[Wangmerlyn]

Summary

• Ignore .worktrees/ so project-local agent worktrees do not pollute git status.
• Document the .worktrees/ convention in AGENTS.md and contributor guidance.
• Document the local review gate before squash merging PRs.

Test Plan

• mkdocs build
• pre-commit run --all-files

Summary by CodeRabbit

• Documentation
  • Expanded contribution guidance with clearer instructions for parallel work, testing expectations, and documentation updates when behavior changes.
• Chores
  • Added a project-local ignore rule for worktree folders.
  • Updated workflow notes to include a final review pass before merging changes.

[coderabbitai]

Warning

Review limit reached

@Wangmerlyn, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 57 minutes and 50 seconds. Learn how PR review limits work.

Your organization has used up its prepaid credits, and credit purchases are no longer available. Enable the review add-on in the billing tab to keep reviews running — you're only billed for reviews past your plan's rate limits ($0.25/file).

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based credits.

🚦 How do rate limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 5bd87efd-7b34-4c62-a0d1-adb999489cba

📥 Commits

Reviewing files that changed from the base of the PR and between 391af74 and 5a94c0c.

📒 Files selected for processing (2)

• AGENTS.md
• docs/contributing.md

📝 Walkthrough

Walkthrough

The PR ignores project-local .worktrees/, adds agent guidance for parallel work there, and expands contribution instructions for tests, docs updates, and review/merge steps.

Changes

Agent workflow guidance

Layer / File(s)	Summary
Project-local worktree setup .gitignore, AGENTS.md	.worktrees/ is added to gitignore, and AGENTS.md instructs agents to use project-local worktrees for parallel work.
Review and merge guidance AGENTS.md, docs/contributing.md	AGENTS.md adds a local subagent review step before merging, and the contributing guide adds parallel-worktree, test, docs/README, and resolved-review-comment merge guidance.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related PRs

• Wangmerlyn/KeepGPU#62: Also updates agent workflow guidance around .worktrees/ and related repository hygiene.

Poem

A bunny hopped through .worktrees/ with glee,
Ignoring busy paths so work stays tidy.
I nibbled the merge notes, crisp and neat,
Then hopped away with review complete.
🐰🌿

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly summarizes the main change: ignoring local worktrees.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch codex/ignore-local-worktrees

---

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.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}

[gemini-code-assist]

Code Review

This pull request updates the repository's configuration and documentation to support parallel agent workflows. Specifically, it adds .worktrees/ to .gitignore and updates both AGENTS.md and docs/contributing.md to instruct contributors and agents to use project-local worktrees and run local code reviews before merging. The review feedback suggests enhancing these instructions by adding concrete git worktree add command examples to make the process more explicit and easier to follow.

Important

The consumer version of Gemini Code Assist on GitHub is being sunset. Starting June 18, 2026, new organization installations will be blocked, and all code review activity will officially cease on July 17, 2026.
For more details on the timeline and next steps, please review the Help Documentation.

[gemini-code-assist]

Adding a concrete command example here helps LLM agents reliably construct the correct git worktree command without guessing the path structure.

Suggested change

	- Use project-local worktrees under `.worktrees/` for parallel agent work.
	- Use project-local worktrees under .worktrees/ for parallel agent work (e.g., git worktree add .worktrees/branch-name branch-name).

[gemini-code-assist]

To make it easier for contributors to follow this convention, it would be helpful to provide a quick example of the git worktree add command showing how to use the .worktrees/ directory.

Suggested change

	- For parallel agent work, branch from the latest `main` and place worktrees
	under `.worktrees/`.
	- For parallel agent work, branch from the latest main and place worktrees
	under .worktrees/ (e.g., git worktree add .worktrees/feature-branch feature-branch).

[Wangmerlyn]

Addressed the review suggestion by adding concrete project-local worktree commands in both AGENTS.md and docs/contributing.md.