gitkkal-init 用于为当前 Git 仓库配置 gitkkal 设置,主要产出是仓库根目录下的 .gitkkal/config.json,并可选处理 .github/PULL_REQUEST_TEMPLATE.md。
用途
- 为单个 Git 仓库建立或更新 gitkkal 的配置文件。
- 可选创建 PR 模板文件,并根据项目成熟度调整模板内容。
主要能力
- 交互式逐字段收集设置:language、commitPattern、branchPattern、splitCommits、askOnAmbiguity、createPrTemplate。
- 每个字段说明其控制内容、可用选项、推荐选项及取舍影响;布尔字段以 true/false 两项呈现,推荐项带 (Recommended) 后缀。
- 校验每个回答是否符合允许值;无效或含糊时重新询问同一字段。
- 写入前展示最终配置预览并请求确认。
- 配置文件已存在时先展示当前设置并询问是否覆盖。
- createPrTemplate 为 true 时:全新仓库生成含 Summary、Changes、Test Plan、Checklist 的默认模板;已有约定的仓库则检查本地 PR 模板、贡献文档、docs、CI 工作流、测试命令等,并可通过 GitHub CLI 参考近期 PR 的章节命名与清单风格;无法访问 PR 历史时说明限制并回退到本地信号。
- 完成后输出创建/更新路径与后续命令,并重新读取配置以确认解析值匹配用户选择。
使用方式
- 在 Git 仓库中触发该技能或使用等价的自然语言请求。
- 技能先通过 git rev-parse --show-toplevel 定位仓库根目录,然后进入逐项提问流程。
- 提问优先使用宿主的交互式提问/选择工具,否则回退为纯聊天;回退时多选项以 1)、2)、3) 独立编号行呈现,不用 Markdown 有序列表,问题本身不加编号。
- 确认后写入配置,仅使用两空格缩进,路径固定为 .gitkkal/config.json。
配置结构 键集合固定为 language、commitPattern、branchPattern、splitCommits、askOnAmbiguity、createPrTemplate;其中 language 允许 en 或 ko,commitPattern 允许 conventional、gitmoji、simple,branchPattern 允许 type/description 或 description-only,其余为布尔值,并以真实 JSON 布尔而非字符串输出。
适用场景
- 新仓库初始化团队提交与分支规范。
- 已有项目在保留既有 PR 约定的前提下补充 gitkkal 配置。
限制
- 仅适用于 Git 仓库;不在 Git 仓库中会停止并说明问题。
- 写配置或 PR 模板前必须获得用户明确确认;覆盖已有文件同样需确认。
- PR 历史不可访问时只能依据本地仓库信号,需说明该限制。