Files
get-shit-done/docs/zh-CN/references/git-integration.md
Rezolv 86fb9c85c3 docs(sdk): registry docs and gsd-sdk query call sites (#2302 Track B) (#2340)
* feat(sdk): golden parity harness and query handler CJS alignment (#2302 Track A)

Golden/read-only parity tests and registry alignment, query handler fixes
(check-completion, state-mutation, commit, validate, summary, etc.), and
WAITING.json dual-write for .gsd/.planning readers.

Refs gsd-build/get-shit-done#2341

* fix(sdk): getMilestoneInfo matches GSD ROADMAP (🟡, last bold, STATE fallback)

- Recognize in-flight 🟡 milestone bullets like 🚧.
- Derive from last **vX.Y Title** before ## Phases when emoji absent.
- Fall back to STATE.md milestone when ROADMAP is missing; use last bare vX.Y
  in cleaned text instead of first (avoids v1.0 from shipped list).
- Fixes init.execute-phase milestone_version and buildStateFrontmatter after
  state.begin-phase (syncStateFrontmatter).

* feat(sdk): phase list, plan task structure, requirements extract handlers

- Register phase.list-plans, phase.list-artifacts, plan.task-structure,
  requirements.extract-from-plans (SDK-only; golden-policy exceptions).
- Add unit tests; document in QUERY-HANDLERS.md.
- writeProfile: honor --output, render dimensions, return profile_path and dimensions_scored.

* feat(sdk): centralize getGsdAgentsDir in query helpers

Extract agent directory resolution to helpers (GSD_AGENTS_DIR, primary
~/.claude/agents, legacy path). Use from init and docs-init init bundles.

docs(15): add 15-CONTEXT for autonomous phase-15 run.

* feat(sdk): query CLI CJS fallback and session correlation

- createRegistry(eventStream, sessionId) threads correlation into mutation events
- gsd-sdk query falls back to gsd-tools.cjs when no native handler matches
  (disable with GSD_QUERY_FALLBACK=off); stderr bridge warnings
- Export createRegistry from @gsd-build/sdk; add sdk/README.md
- Update QUERY-HANDLERS.md and registry module docs for fallback + sessionId
- Agents: prefer node dist/cli.js query over cat/grep for STATE and plans

* fix(sdk): init phase_found parity, docs-init agents path, state field extract

- Normalize findPhase not-found to null before roadmap fallback (matches findPhaseInternal)

- docs-init: use detectRuntime + resolveAgentsDir for checkAgentsInstalled

- state.cjs stateExtractField: horizontal whitespace only after colon (YAML progress guard)

- Tests: commit_docs default true; config-get golden uses temp config; golden integration green

Refs: #2302

* refactor(sdk): share SessionJsonlRecord in profile-extract-messages

CodeRabbit nit: dedupe JSONL record shape for isGenuineUserMessage and streamExtractMessages.

* fix(sdk): address CodeRabbit major threads (paths, gates, audit, verify)

- Resolve @file: and CLI JSON indirection relative to projectDir; guard empty normalized query command

- plan.task-structure + intel extract/patch-meta: resolvePathUnderProject containment

- check.config-gates: safe string booleans; plan_checker alias precedence over plan_check default

- state.validate/sync: phaseTokenMatches + comparePhaseNum ordering

- verify.schema-drift: token match phase dirs; files_modified from parsed frontmatter

- audit-open: has_scan_errors, unreadable rows, human report when scans fail

- requirements PLANNED key PLAN for root PLAN.md; gsd-tools timeout note

- ingest-docs: repo-root path containment; classifier output slug-hash

Golden parity test strips has_scan_errors until CJS adds field.

* fix: Resolve CodeRabbit security and quality findings
- Secure intel.ts and cli.ts against path traversal
- Catch and validate git add status in commit.ts
- Expand roadmap milestone marker extraction
- Fix parsing array-of-objects in frontmatter YAML
- Fix unhandled config evaluations
- Improve coverage test parity mapping

* docs(sdk): registry docs and gsd-sdk query call sites (#2302 Track B)

Update CHANGELOG, architecture and user guides, workflow call sites, and read-guard tests for gsd-sdk query; sync ARCHITECTURE.md command/workflow counts and directory-tree totals with the repo (80 commands, 77 workflows).

Address CodeRabbit: fix markdown tables and emphasis; align CLI-TOOLS GSDTools and state.read docs with implementation; correct roadmap handler name in universal-anti-patterns; resolve settings workflow config path without relying on config_path from state.load.

Refs gsd-build/get-shit-done#2340

* test: raise planner character extraction limit to 48K

* fix(sdk): resolve build TS error and doc conflict markers
2026-04-20 18:09:21 -04:00

6.3 KiB
Raw Blame History

GSD 框架的 Git 集成。

<core_principle>

提交结果,而非过程。

git 日志应该读起来像是发布内容的变更日志,而不是规划活动的日记。 </core_principle>

<commit_points>

事件 提交? 原因
BRIEF + ROADMAP 创建 项目初始化
PLAN.md 创建 中间产物 - 与计划完成一起提交
RESEARCH.md 创建 中间产物
DISCOVERY.md 创建 中间产物
任务完成 原子工作单元(每个任务 1 个提交)
计划完成 元数据提交SUMMARY + STATE + ROADMAP
交接创建 WIP 状态保留

</commit_points>

<git_check>

[ -d .git ] && echo "GIT_EXISTS" || echo "NO_GIT"

如果 NO_GIT静默运行 git init。GSD 项目总是有自己的仓库。 </git_check>

<commit_formats>

## 项目初始化brief + roadmap 一起)
docs: initialize [project-name] ([N] phases)

[PROJECT.md 中的一句话描述]

Phases:
1. [phase-name]: [goal]
2. [phase-name]: [goal]
3. [phase-name]: [goal]

提交内容:

gsd-sdk query commit "docs: initialize [project-name] ([N] phases)" .planning/
## 任务完成(计划执行期间)

每个任务在完成后立即获得自己的提交。

{type}({phase}-{plan}): {task-name}

- [关键变更 1]
- [关键变更 2]
- [关键变更 3]

提交类型:

  • feat - 新功能/功能
  • fix - Bug 修复
  • test - 仅测试TDD RED 阶段)
  • refactor - 代码清理TDD REFACTOR 阶段)
  • perf - 性能改进
  • chore - 依赖、配置、工具

示例:

# 标准任务
git add src/api/auth.ts src/types/user.ts
git commit -m "feat(08-02): create user registration endpoint

- POST /auth/register validates email and password
- Checks for duplicate users
- Returns JWT token on success
"

# TDD 任务 - RED 阶段
git add src/__tests__/jwt.test.ts
git commit -m "test(07-02): add failing test for JWT generation

- Tests token contains user ID claim
- Tests token expires in 1 hour
- Tests signature verification
"

# TDD 任务 - GREEN 阶段
git add src/utils/jwt.ts
git commit -m "feat(07-02): implement JWT generation

- Uses jose library for signing
- Includes user ID and expiry claims
- Signs with HS256 algorithm
"
## 计划完成(所有任务完成后)

所有任务提交后,最后一个元数据提交捕获计划完成。

docs({phase}-{plan}): complete [plan-name] plan

Tasks completed: [N]/[N]
- [Task 1 name]
- [Task 2 name]
- [Task 3 name]

SUMMARY: .planning/phases/XX-name/{phase}-{plan}-SUMMARY.md

提交内容:

gsd-sdk query commit "docs({phase}-{plan}): complete [plan-name] plan" .planning/phases/XX-name/{phase}-{plan}-PLAN.md .planning/phases/XX-name/{phase}-{plan}-SUMMARY.md .planning/STATE.md .planning/ROADMAP.md

注意: 代码文件不包含 - 已按任务提交。

## 交接WIP
wip: [phase-name] paused at task [X]/[Y]

Current: [task name]
[如果阻塞:] Blocked: [reason]

提交内容:

gsd-sdk query commit "wip: [phase-name] paused at task [X]/[Y]" .planning/

<example_log>

旧方法(每个计划提交):

a7f2d1 feat(checkout): Stripe payments with webhook verification
3e9c4b feat(products): catalog with search, filters, and pagination
8a1b2c feat(auth): JWT with refresh rotation using jose
5c3d7e feat(foundation): Next.js 15 + Prisma + Tailwind scaffold
2f4a8d docs: initialize ecommerce-app (5 phases)

新方法(每个任务提交):

# Phase 04 - Checkout
1a2b3c docs(04-01): complete checkout flow plan
4d5e6f feat(04-01): add webhook signature verification
7g8h9i feat(04-01): implement payment session creation
0j1k2l feat(04-01): create checkout page component

# Phase 03 - Products
3m4n5o docs(03-02): complete product listing plan
6p7q8r feat(03-02): add pagination controls
9s0t1u feat(03-02): implement search and filters
2v3w4x feat(03-01): create product catalog schema

# Phase 02 - Auth
5y6z7a docs(02-02): complete token refresh plan
8b9c0d feat(02-02): implement refresh token rotation
1e2f3g test(02-02): add failing test for token refresh
4h5i6j docs(02-01): complete JWT setup plan
7k8l9m feat(02-01): add JWT generation and validation
0n1o2p chore(02-01): install jose library

# Phase 01 - Foundation
3q4r5s docs(01-01): complete scaffold plan
6t7u8v feat(01-01): configure Tailwind and globals
9w0x1y feat(01-01): set up Prisma with database
2z3a4b feat(01-01): create Next.js 15 project

# Initialization
5c6d7e docs: initialize ecommerce-app (5 phases)

每个计划产生 2-4 个提交(任务 + 元数据)。清晰、细粒度、可 bisect。

</example_log>

<anti_patterns>

仍不要提交(中间产物):

  • PLAN.md 创建(与计划完成一起提交)
  • RESEARCH.md中间产物
  • DISCOVERY.md中间产物
  • 小的规划调整
  • "Fixed typo in roadmap"

要提交(结果):

  • 每个任务完成feat/fix/test/refactor
  • 计划完成元数据docs
  • 项目初始化docs

关键原则: 提交可工作的代码和已发布的结果,而非规划过程。

</anti_patterns>

<commit_strategy_rationale>

为什么使用每任务提交?

AI 上下文工程:

  • Git 历史成为未来 Claude 会话的主要上下文源
  • git log --grep="{phase}-{plan}" 显示计划的所有工作
  • git diff <hash>^..<hash> 显示每个任务的确切变更
  • 减少对解析 SUMMARY.md 的依赖 = 更多上下文用于实际工作

失败恢复:

  • 任务 1 已提交 ,任务 2 失败
  • 下次会话中的 Claude看到任务 1 完成,可以重试任务 2
  • 可以 git reset --hard 到最后一个成功的任务

调试:

  • git bisect 找到确切的失败任务,而不仅仅是失败计划
  • git blame 将行追溯到特定任务上下文
  • 每个提交独立可回滚

可观察性:

  • 独立开发者 + Claude 工作流受益于细粒度归因
  • 原子提交是 git 最佳实践
  • 当消费者是 Claude 而非人类时,"提交噪音"无关紧要

</commit_strategy_rationale>