41 lines
1.5 KiB
Markdown
41 lines
1.5 KiB
Markdown
# Git 规划提交
|
||
|
||
通过 `gsd-tools.cjs query commit` 提交规划工件，它会自动检查 `commit_docs` 配置和 gitignore 状态（与旧版 `gsd-tools.cjs commit` 行为相同）。
|
||
|
||
## 通过 CLI 提交
|
||
|
||
先传提交说明，然后用 `--files` 显式传入文件路径。`commit` 与 `commit-to-subrepo` 都应使用 `--files` 来声明要提交的路径。
|
||
|
||
对 `.planning/` 文件始终使用此方式 —— 它会自动处理 `commit_docs` 与 gitignore 检查：
|
||
|
||
```bash
|
||
gsd-tools.cjs query commit "docs({scope}): {description}" --files .planning/STATE.md .planning/ROADMAP.md
|
||
```
|
||
|
||
如果 `commit_docs` 为 `false` 或 `.planning/` 被 gitignore，CLI 会返回 `skipped`（带原因）。无需手动条件检查。
|
||
|
||
## 修改上次提交
|
||
|
||
将 `.planning/` 文件变更合并到上次提交：
|
||
|
||
```bash
|
||
gsd-tools.cjs query commit "" --files .planning/codebase/*.md --amend
|
||
```
|
||
|
||
## 提交消息模式
|
||
|
||
| 命令 | 范围 | 示例 |
|
||
|------|------|------|
|
||
| plan-phase | phase | `docs(phase-03): create authentication plans` |
|
||
| execute-phase | phase | `docs(phase-03): complete authentication phase` |
|
||
| new-milestone | milestone | `docs: start milestone v1.1` |
|
||
| remove-phase | chore | `chore: remove phase 17 (dashboard)` |
|
||
| insert-phase | phase | `docs: insert phase 16.1 (critical fix)` |
|
||
| add-phase | phase | `docs: add phase 07 (settings page)` |
|
||
|
||
## 何时跳过
|
||
|
||
- config 中 `commit_docs: false`
|
||
- `.planning/` 被 gitignore
|
||
- 无变更可提交（用 `git status --porcelain .planning/` 检查）
|