用途
create-issue 是一个用于创建或修订代码仓库问题(Issue)的技能。当用户要求“创建问题”“提交缺陷”“报告问题”“重写问题”或“改进问题标题或正文”时使用。
该技能明确区分问题与 PR:问题描述一个故障或缺失能力,PR 描述提议的变更;PR 相关写作应使用 create-pr。
标题规则
标题应简明陈述问题,并指明受影响的行为。默认不使用“Fix”“Add”“Enable”“Keep”等命令式变更请求作为标题。资料给出的示例包括:
- Visitor country is unavailable to upstream apps
- GeoIP data becomes stale on running installations
- Login returns to the wrong page after checkout
正文结构
应遵循仓库的问题模板和用户要求的格式;若没有,则使用以下结构:
-
Problem:用一两句话说明故障及其影响。
-
Reproduction:相关设置或版本,以及能演示问题的最小步骤。
-
Current behavior:观察到的行为,必要时附简短错误或结果。
-
Desired behavior:报告者需要的结果。
对于缺失功能,应复现暴露该缺口的当前工作流。若问题未被复现,应如实说明,而不是编造步骤或结果。仅在有助于维护者行动时,才添加环境细节、证据或建议方案;可能的实现应与期望结果分开。
应删除重复解释、宣传性表述、对话历史、完整诊断转储,以及无助于复现或解决问题的细节。少量有用段落优于冗长叙述或罗列每一步调查。
发布或更新
发布前应检查仓库指南和模板、搜索是否已有问题,并核实相关陈述。修订时应阅读当前问题,保留有用的附件、链接和用户编辑;未经用户指示不得扩大问题范围。
使用 gh issue create 或 gh issue edit,配合 --title 和 --body-file。发布后需回读已发布的标题和正文。可链接相关 PR,但仅当该 PR 覆盖问题完整的期望结果时,才使用关闭引用。
适用场景与限制
适用于 GitHub 仓库中创建或修改问题、整理问题标题与正文、按模板生成问题内容等场景。资料未提供该技能的具体安装方式、运行环境要求、收费信息或非 GitHub 平台的适用性,这些内容暂未提供。