Files
msd-core/gsd-core/references/universal-anti-patterns.md
Tom Boucher ec7e49a64c fix(#3576): repair all 43 dead references/ cites and gate the canonical resolvable form (#3596)
* test(#3576): gate shipped reference citations on the canonical resolvable form

Failing-first gate for #3576: a backticked bare references/<name>.md cite
resolves from no install location (agents, workflows, and references all
install where a bare relative references/ path is dead). The gate walks the
runtime-loaded trees the issue prescribes, strips @~/ include tokens
PER-TOKEN (a line-skip guard would miss a bare cite sharing a line with an
include — the issue-named trap), pins the genuinely relative ../ href and
canonical forms as non-offenders, and checks canonical cite targets exist.
43 offenders today across 19 files.

* fix(#3576): repair all 43 dead references/ cites to the canonical resolvable form

Every backticked bare references/<name>.md cite across the 19 shipped files
rewritten to gsd-core/references/<name>.md — the form every required_reading
block and @~/ include already uses, and the only form that resolves from any
install location. All 20 cited targets verified to exist; the one genuinely
relative href (plan-phase.md's ../references/mvp-concepts.md) is untouched
(the repair is backtick-anchored). Growth acks: new fragment for the three
first-time paths, #3206-pattern appends to the five fragments already naming
the other grown files (two ack sources may never name the same path).
execute-phase.md lands at 93,391/93,400 and gsd-executor.md at 49,150/49,152
— exactly the issue's projections; every repair fits.

* fix(#3576): drop stale default.md growth ack (nested modes file is hash-attributed, not growth-ratcheted)

Review finding: the emitted-attribution ratchet covers only top-level
workflows/ + agents/ files; discuss-phase/modes/default.md's delta is
source-attributed, so acknowledging its growth is a stale entry the
differential lane fails on.

* chore(#3576): add changeset fragment

* chore(#3576): backfill changeset pr number

---------

Co-authored-by: sim <sim@local>
2026-08-17 15:24:24 -04:00

6.1 KiB

Universal Anti-Patterns

Rules that apply to ALL workflows and agents. Individual workflows may have additional specific anti-patterns.


Context Budget Rules

  1. Never read agent definition files (agents/*.md) -- subagent_type auto-loads them. Reading agent definitions into the orchestrator wastes context for content automatically injected into subagent sessions.
  2. Never inline large files into subagent prompts -- tell agents to read files from disk instead. Agents have their own context windows.
  3. Read depth scales with context window -- check context_window in .planning/config.json. At < 500000: read only frontmatter, status fields, or summaries. At >= 500000 (1M model): full body reads permitted when content is needed for inline decisions. See gsd-core/references/context-budget.md for the complete table.
  4. Delegate heavy work to subagents -- the orchestrator routes, it does not build, analyze, research, investigate, or verify.
  5. Proactive pause warning: If you have already consumed significant context (large file reads, multiple subagent results), warn the user: "Context budget is getting heavy. Consider checkpointing progress."

File Reading Rules

  1. SUMMARY.md read depth scales with context window -- at context_window < 500000: read frontmatter only from prior phase SUMMARYs. At >= 500000: full body reads permitted for direct-dependency phases. Transitive dependencies (2+ phases back) remain frontmatter-only regardless.
  2. Never read full PLAN.md files from other phases -- only current phase plans.
  3. Never read .planning/logs/ files -- only the health workflow reads these.
  4. Do not re-read full file contents when frontmatter is sufficient -- frontmatter contains status, key_files, commits, and provides fields. Exception: at >= 500000, re-reading full body is acceptable when semantic content is needed.

Subagent Rules

  1. NEVER use non-GSD agent types (general-purpose, Explore, Plan, Bash, feature-dev, etc.) -- ALWAYS use subagent_type: "gsd-{agent}" (e.g., gsd-phase-researcher, gsd-executor, gsd-planner). GSD agents have project-aware prompts, audit logging, and workflow context. Generic agents bypass all of this.
  2. Do not re-litigate decisions that are already locked in CONTEXT.md (or PROJECT.md ## Context section) -- respect locked decisions unconditionally.

Questioning Anti-Patterns

Reference: gsd-core/references/questioning.md for the full anti-pattern list.

  1. Do not walk through checklists -- checklist walking (asking items one by one from a list) is the #1 anti-pattern. Instead, use progressive depth: start broad, dig where interesting.
  2. Do not use corporate speak -- avoid jargon like "stakeholder alignment", "synergize", "deliverables". Use plain language.
  3. Do not apply premature constraints -- don't narrow the solution space before understanding the problem. Ask about the problem first, then constrain.

State Management Anti-Patterns

  1. No direct Write/Edit to STATE.md or ROADMAP.md for mutations. Always use gsd-tools query for registered state/roadmap handlers (e.g. state.update, state.advance-plan, roadmap.update-plan-progress), or legacy node …/gsd-tools.cjs for CLI-only commands. Direct Write tool usage bypasses safe update logic and is unsafe in multi-session environments. Exception: first-time creation of STATE.md from template is allowed.

Behavioral Rules

  1. Do not create artifacts the user did not approve -- always confirm before writing new planning documents.
  2. Do not modify files outside the workflow's stated scope -- check the plan's files_modified list.
  3. Do not suggest multiple next actions without clear priority -- one primary suggestion, alternatives listed secondary.
  4. Do not use git add . or git add -A -- stage specific files only.
  5. Do not include sensitive information (API keys, passwords, tokens) in planning documents or commits.

Error Recovery Rules

  1. Git lock detection: Before any git operation, if it fails with "Unable to create lock file", check for stale .git/index.lock and advise the user to remove it (do not remove automatically).
  2. Config fallback awareness: Config loading returns null silently on invalid JSON. If your workflow depends on config values, check for null and warn the user: "config.json is invalid or missing -- running with defaults."
  3. Partial state recovery: If STATE.md references a phase directory that doesn't exist, do not proceed silently. Warn the user and suggest diagnosing the mismatch.

GSD-Specific Rules

  1. Do not check for mode === 'auto' or mode === 'autonomous' -- GSD uses yolo config flag. Check yolo: true for autonomous mode, absence or false for interactive mode.
  2. Prefer gsd-tools query for orchestration when a handler exists; when shelling out to the legacy CLI, use gsd-tools.cjs (not gsd-tools.js or any other filename) — GSD ships the programmatic API as CommonJS for Node.js CLI compatibility.
  3. Plan files MUST follow {padded_phase}-{NN}-PLAN.md pattern (e.g., 01-01-PLAN.md). Never use PLAN-01.md, plan-01.md, or any other variation -- gsd-tools detection depends on this exact pattern.
  4. Do not start executing the next plan before writing the SUMMARY.md for the current plan -- downstream plans may reference it via @ includes.

iOS / Apple Platform Rules

  1. NEVER use Package.swift + .executableTarget (or .target) as the primary build system for iOS apps. SPM executable targets produce macOS CLI binaries, not iOS .app bundles. They cannot be installed on iOS devices or submitted to the App Store. Use XcodeGen (project.yml + xcodegen generate) to create a proper .xcodeproj. See gsd-core/references/ios-scaffold.md for the full pattern.
  2. Verify SwiftUI API availability before use. Many SwiftUI APIs require a specific minimum iOS version (e.g., NavigationSplitView is iOS 16+, List(selection:) with multi-select and @Observable require iOS 17). If a plan uses an API that exceeds the declared IPHONEOS_DEPLOYMENT_TARGET, raise the deployment target or add #available guards.