Closed
docs: 沉淀 issue 创建模板(四段结构 + 起草前查证清单 + 验收锚点) #614
aflyingtoAdd on  Sep 30Closed at  13 days ago
aflyingtoCollaborators
Sep 30 Create

背景

  • docs/ai-templates/ 现有 9 种模板均为流程状态模板(验证记录、进度、blocked、close、自检等),缺少创建 issue 时的结构模板;docs/AI-TEMPLATES.md 的定位("降低 AI 自由发挥空间")覆盖此场景但无对应资产
  • 近期环境初始化系列 issue(#611、#612、#613)验证了一套有效结构:背景(问题+代码证据)→ 改动建议 → 验收标准 → 影响范围,辅以起草前查证清单(确认 spec 无既有覆盖、file:line 证据、标签体系、不破坏既有契约)与验收锚点(把"完成的样子"直接钉进 issue,如 #613 的示例输出块)。该结构经多轮评审迭代收敛,值得固化为模板
  • 仓库无 GitCode 平台级 issue 模板(.gitcode/ 下仅 workflows/);GitCode 是否渲染 .gitcode/ISSUE_TEMPLATE/ 目录约定未经验证,官方文档覆盖有限

改动建议

  1. 验证任务(第一步):使用 infra-test/* 仓库实验 GitCode 对 .gitcode/ISSUE_TEMPLATE/ 的支持情况,记录结论与证据;生效则新增平台模板路径(面向人工 web UI 创建),不生效则在本文档记录结论并关闭该支线
  2. 新增 docs/ai-templates/issue-create.md,内容含:
    • 四段结构:背景与证据 / 改动建议 / 验收标准 / 影响范围
    • 起草前查证清单:grep spec/+docs/ 确认无既有覆盖;代码相关须读源码取 file:line 证据(不写推测);标签按 issue-workflow.md 与 spec/governance/sigs/*.yaml;确认不破坏既有契约(CI 测试契约、文档化行为),如改变契约须在验收标准中显式声明或另走 RFC;敏感信息脱敏(token、机器特定配置)
    • 验收锚点指引:UX/输出类需求须附示例输出块,使验收可对照
  3. scripts/validate-ai-record.py 注册 issue-create kind 的 SCHEMAS,纳入 make validate-ai-templates 自动校验
  4. docs/AI-TEMPLATES.md 补充该模板的说明与使用指引
  5. 按 spec/governance/docs-governance.md 检查同步范围(AGENTS/CLAUDE 入口是否需引用)

验收标准

  • make validate-ai-templates 通过,且新 kind 被覆盖
  • 模板包含四段结构、查证清单、验收锚点指引三个组成部分
  • 平台验证结论(生效/不生效)有实验记录;生效时含 .gitcode/ISSUE_TEMPLATE/ 落地
  • 按模板新建的 issue 具备:代码/文档证据、可测试的验收标准、明确影响范围

影响范围

docs/ai-templates/issue-create.md(新增)、docs/AI-TEMPLATES.md、scripts/validate-ai-record.py、(视验证结果).gitcode/ISSUE_TEMPLATE/

likedislike
AaflyingtoCollaborators
Sep 30 Added label: scope/docs, status/triage,type/docs
aflyingtoCollaborators
13 days ago Comments:

验证记录

  • 当前版本或分支: main @ 2697018
  • 验证时间: 2026-10-26
  • 复现命令: ls docs/ai-templates/;grep -rn "issue" docs/AI-TEMPLATES.md | head -5;ls .gitcode/
  • 实际结果: docs/ai-templates/ 现有 10 个模板均为流程状态类(验证/进度/blocked/close/自检/评审结果等),无 issue 创建结构模板;.gitcode/ 下仅 workflows/,无平台级 ISSUE_TEMPLATE;issue 主张属实
  • 预期结果: AI 协作者起草 issue 时有固化结构模板(四段结构 + 起草前查证清单 + 验收锚点),平台模板支持情况有实验结论
  • 时间线检查: issue 于 2026-09-30 创建(基于 #611–#613 系列的经验沉淀),无关联 PR、无重复项;本会话随后以同结构创建 7 个 issue(GC_HOST 归因/确认组件/回归矩阵/token_valid/镜像契约/GitCode race/unshallow 共 7 项,编号 621–625、627、628),全部通过四角色评审管线进入流程——结构有效性又添 7 个样本
  • 结论: 继续修复——按 issue 改动建议顺序执行:①先做平台验证实验(infra-test 仓试 .gitcode/ISSUE_TEMPLATE/,记录结论);②新增 issue-create.md 模板;③注册 validate-ai-record.py 的 issue-create kind;④AI-TEMPLATES.md 补说明;⑤docs-governance 同步范围检查
likedislike
AaflyingtoCollaborators
13 days ago Added label: risk/low, status/verified; Removed label: status/triage
AaflyingtoCollaborators
13 days ago Added label: status/in-progress
aflyingtoCollaborators
13 days ago Comments:

平台验证实验记录(改动建议第 1 项)

  • 实验设计: 向 infra-test/gctest1(main 分支)推送四个候选路径的探针模板(各自带可区分的实验名 front-matter):.gitcode/ISSUE_TEMPLATE/、.gitea/ISSUE_TEMPLATE/、.github/ISSUE_TEMPLATE/、根目录 ISSUE_TEMPLATE/(探针提交 9754426、08dfd22)
  • 验证方式: 人工打开 https://gitcode.com/infra-test/gctest1/issues/new 核验模板选择器(CLI 无法判定:创建页为登录态 JS 渲染,未认证 HTML 探针无信号;gc api repos/.../issue_templates 端点 404)
  • 结论: GitCode 仅渲染 .github/ISSUE_TEMPLATE/ 约定——web UI 模板选择器仅显示"Bug 报告(实验-.github)";.gitcode、.gitea、根目录 ISSUE_TEMPLATE 均不生效
  • 推论: .github/ISSUE_TEMPLATE/ 同时是 GitHub 原生约定——主仓该目录经镜像同步后一个目录服务双平台 web UI
  • 探针清理: 实验后已移除全部四目录(清理提交 066c2d9),测试仓恢复原状
  • 落地: 主仓新增 .github/ISSUE_TEMPLATE/bug_report.md 与 feature_request.md(四段结构与 AI 侧 issue-create 模板对齐,面向人工 web UI 报告者)
likedislike
AaflyingtoCollaborators
13 days ago Associated pull request
aflyingtoCollaborators
13 days ago Comments:

实验记录补强(评审观察项):

  • 远端清理核验:infra-test/gctest1 远端 main HEAD 即清理提交 066c2d9,工作区四种 ISSUE_TEMPLATE 路径目录计数为 0(fetch + reset 到 origin/main 后实测)——探针清理有直接远端证据
  • 四路可区分性:每个探针的 front-matter name 均带路径标识("Bug 报告(实验-.gitcode)"等),web UI 选择器仅显示 .github 一项即四路结论的可审计依据
likedislike
AaflyingtoCollaborators
13 days ago Added label: status/ready-for-review
aflyingtoCollaborators
13 days ago Comments:

开发进度

  • 当前状态: ready-for-review(PR !601 已完成自检、四角色独立评审四轮全部 approved、双端 CI 全绿,等待人工最终确认与合并)
  • 根因: ai-templates 全为流程状态类、缺 issue 创建结构模板;四段结构经十个 issue 实践验证未固化;平台模板约定未经验证(详见验证记录与实验记录)
  • 主要修改: 5 文件——issue-create.md 模板(四段 + 六项查证清单 + 占位符约定)、.github/ISSUE_TEMPLATE 双平台 web UI 模板、validate-ai-record.py(issue-create kind + 标题式字段解析 + 占位符执法)、AI-TEMPLATES.md、issue-workflow.md §1 spec 锚点
  • 影响范围: 纯文档/模板/校验脚本;零生产代码
  • 单元测试: go test ./... 163 包全通过;make validate-ai-templates 10 模板全过;record 执法三向验证(原样拒/混合拒/填充过)
  • 构建: 无涉
  • 实际命令验证: 平台实验(四路径探针 + 人工核验 + 清理 + 远端证据回填);校验器构造性实验全链
  • 安全影响: 平台模板含脱敏提示与私密渠道指引(安全评审 P2 修复);无凭证变化
  • 文档同步: AI-TEMPLATES + issue-workflow spec 锚点 + AGENTS 自动接线;全仓残留扫描闭环
  • 风险或未覆盖项: risk/medium,合并前需人工最终确认;labels front-matter 自动打标留待首个使用场景;record 自动化覆盖登记 issue 629
  • 关联 PR: !601
likedislike
aflyingtoCollaborators
13 days ago Comments:

模板效果实测确认(PR !601 平台模板验收补强)

  • 实测方式:将 !601 分支的正式模板(bug_report.md / feature_request.md 最终版,含脱敏提示与私密渠道指引)原样推上 infra-test/gctest1 main(预览提交 d4f4e22),人工在 web UI 创建页核验
  • 结果:模板选择器正常显示「Bug 报告」与「功能建议」两项,模板渲染正常(平台实验结论在正式模板上复验成立)
  • 清理:确认后已移除预览(清理提交 d972d19,.github 目录已不存在),测试仓恢复原状
  • 未实验项维持:front-matter labels(type/bug 等)的自动打标行为仍待首个真实使用场景验证(需实际创建 issue)——已记录于 PR !601 自检未覆盖项
likedislike
AaflyingtoCollaborators
13 days ago Close issue
AaflyingtoCollaborators
13 days ago Added label: status/merged