Document worktrees for agent and package work

Open Beginner friendly
  • Is something wrong?
#137 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
1-3 hours
Newbie friendliness
72/100
Issue type
Documentation
Clarity
Clearly specified
Activity status
Active
Tech stack
markdown
Domain
documentation

Research direction

The new section belongs in docs/agents/, and AGENTS.md needs a one-line pointer to it. The core.worktree lesson goes in docs/verification/automation.md, which should link to the new section rather than repeat it. Read the PR #134 retro notes for the exact refusal wording before writing. Done when the create, remove and prune commands are documented, the lesson is recorded, and the links resolve.

Written by the indexing model from the issue text.

Description

ready-for-agent

What to build

A short worktree section in docs/agents/ covering when to use a worktree, how to create and remove one, how to prune merged branches and stale worktrees at the end of a session, and the core.worktree redirect that makes an agent's isolation worktree get refused (what happened, what it cost, the fix). Documentation only, no script.

Origin: the retro of PR #134. An agent worktree was refused and had to be pruned by hand, the maintainer asked whether a first publish belonged in a worktree, and ended with a request to clean up branches and worktrees.

Record the core.worktree failure as a repo-specific lesson in docs/verification/automation.md, as AGENTS.md requires. Link rather than duplicate between the two.

Acceptance criteria

  • The worktree section exists and AGENTS.md or the workflow doc points to it in one line.
  • It gives the create, remove and end-of-session cleanup commands.
  • The core.worktree refusal is documented with its fix and recorded as a lesson in automation.md.

Blocked by

None (can start immediately).

Dominant language
TypeScript
Stars
1
Forks
0
Avg merge
2h 8m
Merged PRs (30d)
64

Getting set up

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.

More from nemchik/biome-plugin-suitescript

All issues in nemchik/biome-plugin-suitescript

Similar issues

More TypeScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.