Skip to content

working-in-teams.md

Latest commit

 

History

History
101 lines (74 loc) · 3.23 KB

working-in-teams.md

File metadata and controls

101 lines (74 loc) · 3.23 KB

Working in Teams

GSD supports multi-user workflows where several developers work on the same repository concurrently.

Setup

1. Set Team Mode

The simplest way to configure GSD for team use is to set mode: team in your project preferences. This enables unique milestone IDs, push branches, and pre-merge checks in one setting:

# .gsd/PREFERENCES.md (project-level, committed to git)
---
version: 1
mode: team
---

This is equivalent to manually setting unique_milestone_ids: true, git.push_branches: true, git.pre_merge_check: true, and other team-appropriate defaults. You can still override individual settings — for example, adding git.auto_push: true on top of mode: team if your team prefers auto-push.

Alternatively, you can configure each setting individually without using a mode (see Git Strategy for details).

2. Configure .gitignore

Share planning artifacts (milestones, roadmaps, decisions) while keeping runtime files local:

# ── GSD: Runtime / Ephemeral (per-developer, per-session) ──────
.gsd/auto.lock
.gsd/completed-units.json
.gsd/STATE.md
.gsd/metrics.json
.gsd/activity/
.gsd/runtime/
.gsd/worktrees/
.gsd/milestones/**/continue.md
.gsd/milestones/**/*-CONTINUE.md

What gets shared (committed to git):

  • .gsd/PREFERENCES.md — project preferences
  • .gsd/PROJECT.md — living project description
  • .gsd/REQUIREMENTS.md — requirement contract
  • .gsd/DECISIONS.md — architectural decisions
  • .gsd/milestones/ — roadmaps, plans, summaries, research

What stays local (gitignored):

  • Lock files, metrics, state cache, runtime records, worktrees, activity logs

3. Commit the Preferences

git add .gsd/PREFERENCES.md
git commit -m "chore: enable GSD team workflow"

commit_docs: false

For teams where only some members use GSD, or when company policy requires a clean repo:

git:
  commit_docs: false

This adds .gsd/ to .gitignore entirely and keeps all artifacts local. The developer gets the benefits of structured planning without affecting teammates who don't use GSD.

Migrating an Existing Project

If you have an existing project with .gsd/ blanket-ignored:

  1. Ensure no milestones are in progress (clean state)
  2. Update .gitignore to use the selective pattern above
  3. Add unique_milestone_ids: true to .gsd/PREFERENCES.md
  4. Optionally rename existing milestones to use unique IDs: 
    I have turned on unique milestone ids, please update all old milestone
ids to use this new format e.g. M001-abc123 where abc123 is a random
6 char lowercase alpha numeric string. Update all references in all
.gsd file contents, file names and directory names. Validate your work
once done to ensure referential integrity.
  5. Commit

Parallel Development

Multiple developers can run auto mode simultaneously on different milestones. Each developer:

  • Gets their own worktree (.gsd/worktrees/<MID>/, gitignored)
  • Works on a unique milestone/<MID> branch
  • Squash-merges to main independently

Milestone dependencies can be declared in M00X-CONTEXT.md frontmatter:

---
depends_on: [M001-eh88as]
---

GSD enforces that dependent milestones complete before starting downstream work.