docs(gh-skill): document gh issue develop --checkout --worktree - #14265
Merged
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Copilot-Session: 6377b1fb-b7b7-4ed0-8257-5a68c846a25d
tidy-dev
approved these changes
Aug 26, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Documents the worktree workflow for issue-linked branches.
Changes:
- Adds
gh issue develop --checkout --worktree. - Documents flag constraints.
Show a summary per file
| File | Description |
|---|---|
skills/gh/SKILL.md |
Adds the issue worktree guidance. |
Review details
💡 Configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
- Files reviewed: 1/1 changed files
- Comments generated: 0
- Review effort level: Balanced
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
The
ghagent skill (skills/gh/SKILL.md) documents usefulghinvocation patterns for agents, including checking a PR out into a git worktree withgh pr checkout <n> --worktree <path>. The equivalent capability for issues,gh issue develop <n> --checkout --worktree <path>, was not documented.This adds a note covering
gh issue develop --checkoutand the--worktreeflag, including its constraints, so agents know they can create a linked branch for an issue and check it out into a worktree instead of switching the current branch.How did you test this change?
This is a documentation-only change to a skill Markdown file, so there is no runtime behavior to exercise. I verified the documented flags and constraints against the command source in
pkg/cmd/issue/develop/develop.go:--checkoutcreates and checks out the linked branch.--worktree <path>checks the branch out into a worktree.--worktreerequires--checkout, cannot be blank, and is mutually exclusive with--list.Key points
Placed the new note directly below the existing
gh pr checkout --worktreeentry in the "Other notes" section to keep the two worktree patterns together.Notes for reviewers
Start in
skills/gh/SKILL.md, "Other notes" section. The wording mirrors the adjacentpr checkout --worktreenote for consistency.Authorship and follow-up
Who wrote this:
Who answers review comments: