patrick91 / patrick91/shortcake

Add support for worktrees

Open
#27 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
4
Forks
0
Avg merge
4h 22m
Merged PRs (30d)
5

Description

Problem

Shortcake should work correctly when invoked from a Git linked worktree, not only from the primary checkout.

Current status

Some low-level paths now use pygit2 repository discovery and repo.path, but worktree support is not covered end-to-end. There are still Git-local state files and recovery paths that need explicit verification in linked worktrees.

Remaining work

  • Add tests that run core commands from a linked worktree.
  • Verify Git-local state files are stored in the correct git dir for that worktree.
  • Audit state/cache paths such as PR cache, restack state, and future transaction/recovery files.
  • Verify branch switching, restack/continue/abort, submit, pull, sync, and UI startup from a worktree.

Acceptance criteria

  • Commands behave the same from the main worktree and a linked worktree.
  • No command assumes .git is a directory in the working tree.
  • State cleanup and recovery work from linked worktrees.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Begin with the existing pygit2 repository-discovery and repo.path handling, then exercise branch switching, restack/continue/abort, submit, pull, sync, and UI startup from a linked worktree. Audit the PR cache, restack state, and other Git-local state or recovery paths; done means core commands behave like they do in the main worktree and cleanup and recovery work correctly.

Written by the indexing model from the issue text.

Assessment

Tech stack
git, python
Domain
cli, devtools
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.