已合并
docs: sediment the issue-create template and platform web-UI templates #601
aflyingto创建于 10 天前
docs: sediment the issue-create template and platform web-UI templates #601
已合并
共 6 个文件变更+171-8
| @@ -0,0 +1,29 @@ | |||
| 1 | +--- | ||
| 2 | +name: Bug 报告 | ||
| 3 | +about: 报告命令行为、文档或流程与预期不符的问题 | ||
| 4 | +labels: 'type/bug' | ||
| 5 | +--- | ||
| 6 | +## 背景与证据 | ||
| 7 | + | ||
| 8 | +### 问题 | ||
| 9 | + | ||
| 10 | +（发生了什么、期望是什么） | ||
| 11 | + | ||
| 12 | +### 证据 | ||
| 13 | + | ||
| 14 | +- 复现命令与输出（代码相关请附 file:line；输出中的 token / 密钥 / 内部地址请先脱敏后再粘贴） | ||
| 15 | +- 版本 / 分支 / 平台 | ||
| 16 | + | ||
| 17 | +> 安全漏洞请勿在公开 issue 中披露细节：请使用 `gc issue create --security-hole` 提交私密 issue（规则详见仓库内 spec/foundations/security.md）。 | ||
| 18 | + | ||
| 19 | +## 改动建议 | ||
| 20 | + | ||
| 21 | +（你认为应该怎么修；不确定可写"待定"） | ||
| 22 | + | ||
| 23 | +## 验收标准 | ||
| 24 | + | ||
| 25 | +（修复后应满足的可测试条件；涉及输出变化请附示例） | ||
| 26 | + | ||
| 27 | +## 影响范围 | ||
| 28 | + | ||
| 29 | +（涉及的命令 / 文件 / 模块） | ||
| @@ -0,0 +1,28 @@ | |||
| 1 | +--- | ||
| 2 | +name: 功能建议 | ||
| 3 | +about: 提议新命令、参数或行为改进 | ||
| 4 | +labels: 'type/feature' | ||
| 5 | +--- | ||
| 6 | +## 背景与证据 | ||
| 7 | + | ||
| 8 | +### 问题 | ||
| 9 | + | ||
| 10 | +（要解决的用户痛点或场景；如与既有 issue/PR 相关请引用） | ||
| 11 | + | ||
| 12 | +### 证据 | ||
| 13 | + | ||
| 14 | +（支撑该需求的场景、现有命令的不足之处） | ||
| 15 | + | ||
| 16 | +## 改动建议 | ||
| 17 | + | ||
| 18 | +（提议的方案；含设计取舍时列出可选项并标注"评审定夺"） | ||
| 19 | + | ||
| 20 | +## 验收标准 | ||
| 21 | + | ||
| 22 | +（完成后长什么样；UX/输出类请附示例输出块） | ||
| 23 | + | ||
| 24 | +## 影响范围 | ||
| 25 | + | ||
| 26 | +（涉及的命令 / 文件 / 模块；是否触碰既有契约） | ||
| 27 | + | ||
| 28 | +> 若建议涉及安全漏洞细节，请勿在公开 issue 中披露：使用 `gc issue create --security-hole` 提交私密 issue。 | ||
| @@ -63,6 +63,7 @@ make validate-ai-record FILE=/path/to/pr-self-check.md KIND=pr-self-check | |||
| 63 | 以下文件可直接作为 `--body-file` 或 `--comment-file` 的起点： | 63 | 以下文件可直接作为 `--body-file` 或 `--comment-file` 的起点： |
| 64 | 64 | ||
| 65 | - [task-start-checklist.md](./ai-templates/task-start-checklist.md) | 65 | - [task-start-checklist.md](./ai-templates/task-start-checklist.md) |
| 66 | +- [issue-create.md](./ai-templates/issue-create.md) | ||
| 66 | - [issue-verification.md](./ai-templates/issue-verification.md) | 67 | - [issue-verification.md](./ai-templates/issue-verification.md) |
| 67 | - [issue-progress.md](./ai-templates/issue-progress.md) | 68 | - [issue-progress.md](./ai-templates/issue-progress.md) |
| 68 | - [issue-blocked.md](./ai-templates/issue-blocked.md) | 69 | - [issue-blocked.md](./ai-templates/issue-blocked.md) |
| @@ -72,6 +73,28 @@ make validate-ai-record FILE=/path/to/pr-self-check.md KIND=pr-self-check | |||
| 72 | - [pr-review-outcome.md](./ai-templates/pr-review-outcome.md) | 73 | - [pr-review-outcome.md](./ai-templates/pr-review-outcome.md) |
| 73 | - [docs-only-self-check.md](./ai-templates/docs-only-self-check.md) | 74 | - [docs-only-self-check.md](./ai-templates/docs-only-self-check.md) |
| 74 | 75 | ||
| 76 | +## 0. Issue 创建（四段结构） | ||
| 77 | + | ||
| 78 | +适用场景： | ||
| 79 | + | ||
| 80 | +- 起草新 issue（bug、feature、test、docs 均适用） | ||
| 81 | +- 模板含起草前查证清单（HTML 注释形态，对平台不可见、对 AI 可见）与验收锚点指引 | ||
| 82 | + | ||
| 83 | +结构为四段标题式字段（区别于其余模板的列表式字段）： | ||
| 84 | + | ||
| 85 | +- `## 背景与证据`（含 `### 问题` 与 `### 证据`，证据须 file:line 或命令输出，不写推测） | ||
| 86 | +- `## 改动建议`（含设计取舍时标注"评审定夺"） | ||
| 87 | +- `## 验收标准`（可测试的判定条件；UX/输出类附示例输出块作为锚点） | ||
| 88 | +- `## 影响范围` | ||
| 89 | + | ||
| 90 | +示例命令： | ||
| 91 | + | ||
| 92 | +```bash | ||
| 93 | +# 起草后校验结构与章节完整性（record 模式会抓空章节） | ||
| 94 | +python3 scripts/validate-ai-record.py --mode record --kind issue-create /path/to/draft.md | ||
| 95 | +gc issue create -R owner/repo --title "..." --body-file /path/to/draft.md | ||
| 96 | +``` | ||
| 97 | + | ||
| 75 | ## 1. Issue 验证记录 | 98 | ## 1. Issue 验证记录 |
| 76 | 99 | ||
| 77 | 适用场景： | 100 | 适用场景： |
| @@ -264,4 +287,4 @@ gc pr review <number> --comment-file /path/to/self-check.md -R owner/repo | |||
| 264 | 287 | ||
| 265 | --- | 288 | --- |
| 266 | 289 | ||
| 267 | -**最后更新**: 2026-04-03 | 290 | +**最后更新**: 2026-10-26 |