Skip to content

Commit b8bed81

Browse files
Move Git Worktrees documentation to Ways-of-Working directory and update links
1 parent 4b16e2f commit b8bed81

5 files changed

Lines changed: 5 additions & 35 deletions

File tree

docs/Agents/Workflow.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,12 +30,12 @@ See [Issue Format](../Ways-of-Working/Issue-Format.md) and [Issue Hierarchy](../
3030
Covers the **Build** and **Ship** phases. Takes a planned issue and delivers a merge-ready pull request. Owns the full loop:
3131

3232
1. **Orient** — read the issue, README, contribution guide, and standards.
33-
2. **Branch and draft PR** — create a [worktree](Git-Worktrees.md) for the issue, push early so CI attaches and progress is visible. Assign to the user. Link to the issue.
33+
2. **Branch and draft PR** — create a [worktree](../Ways-of-Working/Git-Worktrees.md) for the issue, push early so CI attaches and progress is visible. Assign to the user. Link to the issue.
3434
3. **Build** — micro-commits, one logical change each. Update the issue as each task completes (not in bulk).
3535
4. **Respond** — process reviewer feedback and CI failures. One thread at a time.
3636
5. **Finalize** — update PR title, labels, and description as a user-facing release note.
3737

38-
See [Git Worktrees](Git-Worktrees.md), [PR Format](../Ways-of-Working/PR-Format.md), [Commit Conventions](../Ways-of-Working/Commit-Conventions.md), and [Standards](Standards/index.md).
38+
See [Git Worktrees](../Ways-of-Working/Git-Worktrees.md), [PR Format](../Ways-of-Working/PR-Format.md), [Commit Conventions](../Ways-of-Working/Commit-Conventions.md), and [Standards](Standards/index.md).
3939

4040
### Reviewer
4141

docs/Agents/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ The full workflow — phases, the loop, and how they connect — is documented i
3737
## What lives here
3838

3939
- **[Workflow](Workflow.md)** — How the roles connect, the Context Development Lifecycle, and where it meets DevOps.
40-
- **[Git Worktrees](Git-Worktrees.md)** — Bare-clone + worktree layout for parallel work with agents.
40+
- **[Git Worktrees](../Ways-of-Working/Git-Worktrees.md)** — Bare-clone + worktree layout for parallel work with agents.
4141
- **[Standards](Standards/index.md)** — Per-language and per-platform standards referenced by the agents.
4242

4343
## Guiding intent
Lines changed: 0 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -97,34 +97,3 @@ git -C .bare worktree remove 42-add-pagination
9797
# Prune if needed (removes stale worktree references)
9898
git -C .bare worktree prune
9999
```
100-
101-
The sync script handles this automatically — worktrees whose branch no longer exists on any remote are removed during the next sync.
102-
103-
## Parallel agents
104-
105-
The worktree model enables multiple agents to work in the same repository at the same time:
106-
107-
- Each agent operates in its own worktree (its own issue folder).
108-
- No merge conflicts during development — conflicts only surface at PR merge time.
109-
- The default branch worktree provides a stable reference for all agents to read from.
110-
- CI runs independently per PR, so agents don't block each other.
111-
112-
```text
113-
Agent A: working in 42-add-pagination/
114-
Agent B: working in 43-fix-auth-flow/
115-
Human: reviewing in main/ or reading docs
116-
```
117-
118-
## VS Code integration
119-
120-
- **Open the worktree folder directly** — VS Code's Git extension auto-detects the git context.
121-
- **Multi-root workspace** — add multiple worktrees to one window (`File → Add Folder to Workspace`) to reference `main/` while coding in another.
122-
- **Terminal cwd** — ensure the integrated terminal is in the worktree folder, not the bare root.
123-
124-
## Rules
125-
126-
1. **Never commit directly to the default branch worktree.** It exists for reference only.
127-
2. **One worktree per issue.** The folder name matches the branch name: `<N>-<slug>`.
128-
3. **Clean up after merge.** Remove the worktree and let the sync script prune stale branches.
129-
4. **All git config lives in `.bare/`** — it applies to every worktree automatically.
130-
5. **Only `origin` and `upstream` remotes.** No other remotes. `upstream` only exists for forks.

docs/Ways-of-Working/Workflow.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ See [Issue Format § Sections 2–3](Issue-Format.md), [Issue Hierarchy](Issue-H
9090

9191
Execute the plan:
9292

93-
1. **Branch** — create a branch (and [worktree](../Agents/Git-Worktrees.md)) for the issue.
93+
1. **Branch** — create a branch (and [worktree](Git-Worktrees.md)) for the issue.
9494
2. **Draft PR** — push early and open a draft pull request. Link it to the issue. This makes progress visible and attaches CI from the start.
9595
3. **Implement** — work through the checklist. One logical change per commit. Update the issue as each task completes.
9696
4. **Test locally** — don't push known failures to CI. Push work as far inward as it can go.

docs/Ways-of-Working/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ This section documents the principles, processes, and norms that every contribut
1313
- **[PR Format](PR-Format.md)** — Pull request title, description, change types, and labels.
1414
- **[Commit Conventions](Commit-Conventions.md)** — How we write commit messages.
1515
- **[Review Etiquette](Review-Etiquette.md)** — Tone, scope, severity prefixes, and how to disagree well.
16+
- **[Git Worktrees](Git-Worktrees.md)** — Bare-clone + worktree layout for parallel, conflict-free development.
1617
- **[README-Driven Context](Readme-Driven-Context.md)** — Why the README is the front door and the source of truth.
1718

1819
## Who this is for

0 commit comments

Comments
 (0)