Skip to content

docs(worktree): add README#80

Merged
amondnet merged 3 commits intomainfrom
docs/worktree-readme
Mar 6, 2026
Merged

docs(worktree): add README#80
amondnet merged 3 commits intomainfrom
docs/worktree-readme

Conversation

@amondnet
Copy link
Contributor

@amondnet amondnet commented Mar 6, 2026

Summary

  • Add plugins/worktree/README.md with plugin documentation
  • Covers overview, architecture diagram, worktree detection strategies, tool coverage scope, installation instructions, and manual hook testing examples

Test plan

  • Review README content for accuracy
  • Verify installation instructions work as expected

Summary by cubic

Add plugins/worktree/README.md documenting the Worktree plugin, how it isolates git worktrees, and how it blocks parent project access.

Clarifies installation (separate interactive vs direct CLI with --scope) and cleans hook test examples; includes overview, hook flow, detection strategies, tool coverage, development tests, and Bash caveats.

Written for commit 6f20692. Summary will update on new commits.

Add plugin documentation covering overview, architecture diagram,
worktree detection strategies, tool coverage scope, installation,
and manual hook testing examples.
@vercel
Copy link

vercel bot commented Mar 6, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
claude-code-plugins Ready Ready Preview, Comment Mar 6, 2026 5:09am

Request Review

@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello, 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 introduces comprehensive documentation for the worktree plugin. The plugin is designed to enhance Git worktree isolation within Claude Code by preventing accidental access to parent project files. The added README explains the plugin's functionality, how it detects worktrees, its scope across various tools, and provides clear instructions for installation and manual testing.

Highlights

  • New Worktree Plugin Documentation: Added plugins/worktree/README.md to provide comprehensive documentation for the Git worktree isolation plugin for Claude Code.
  • Documentation Content: The README details the plugin's overview, architecture diagram, worktree detection strategies, tool coverage scope, installation instructions, and manual hook testing examples.
Changelog
  • plugins/worktree/README.md
    • Added comprehensive documentation for the worktree plugin, detailing its functionality, installation, and usage.
Using Gemini Code Assist

The 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 /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.

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

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a 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 adds a comprehensive README.md for the worktree plugin. The documentation is well-structured and covers the plugin's purpose, architecture, and usage instructions. I've provided a couple of suggestions to improve the clarity of the installation and testing instructions for a better user experience.

Note: Security Review has been skipped due to the limited scope of the PR.

Copy link

@cubic-dev-ai cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 1 file

@amondnet amondnet self-assigned this Mar 6, 2026
- Restructure Installation section: separate interactive claude shell
  steps from direct CLI commands for clarity
- Remove unnecessary backslash line continuation in hook test example
@amondnet amondnet merged commit f86bb7b into main Mar 6, 2026
7 checks passed
@amondnet amondnet deleted the docs/worktree-readme branch March 6, 2026 05:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant