根据描述、错误或想法起草结构良好的 GitHub issue,支持错误报告、功能请求、改进和任务,可选择直接提交。
gh- issues- 撰稿人是一项面向实际任务的技能,主要用于草稿清晰、 可用操作的 GitHub 问题, 由简要说明、 错误消息或想法来表达;覆盖错误报告、 特性请求、 增强和任务;
该技能适合需要稳定复用相关能力的场景,可作为自动化工作流的一部分,也便于后续检查、调整和扩展。从功能定位来看,该技能强调把分散的操作要求整理成清晰、可复用的处理流程,使用户能够围绕既定目标快速准备输入、选择执行方式并获得结构化结果。实际使用前应先确认任务范围、数据来源、运行环境、必要权限和关键参数,再依据技能说明逐步执行;
若输入条件不完整,应先补齐信息或采用保守配置,避免因错误假设导致结果偏离需求。执行过程中需要关注工具调用是否成功、接口或依赖是否可用、输出格式是否符合预期,并对异常提示、缺失字段和边界情况进行处理;涉及批量任务时,还应保存进度,避免中断后重复操作。
根据简要描述、错误信息或初步想法,自动生成清晰、可操作的 GitHub Issue。支持 Bug 报告、功能请求(Feature Request)、改进项(Enhancement)和任务(Task)等类型。
主动询问(或从上下文中推断)以下信息:
git remote get-url origin 自动检测;否则需向用户确认)若用户已提供足够上下文,可跳过提问,直接生成草稿并提交确认。
选用下方对应模板,并完整填写所有字段;仅当某节内容确无相关信息时方可省略。
## 描述 ## 复现步骤 1. 2. 3. ## 预期行为 ## 实际行为 ## 运行环境 - OS: - 浏览器 / 运行时 / 版本: - 相关配置或依赖: ## 日志 / 截图 ## 补充信息
## 问题 / 动机 ## 提议方案 ## 已考虑的替代方案 ## 接受标准(Acceptance Criteria) - [ ] - [ ] ## 补充信息
## 当前行为 ## 期望行为 ## 此改进的意义 ## 建议实现方式
## 待办事项 ## 原因 / 上下文 ## 完成定义(Definition of Done) - [ ] - [ ]
按 Issue 类型采用不同标题格式:
| 类型 | 格式模式 | 示例 |
|---|---|---|
| Bug | Bug: <失败现象> on <发生位置> |
Bug: 500 on POST /login when payload missing field |
| Feature | Feature: <能力> for <使用者/场景> |
Feature: CSV export for admin reports |
| Enhancement | Enhance: <对象> — <改进点> |
Enhance: error messages — add field-level detail |
| Task | Task: <动词> <对象> |
Task: upgrade Stripe SDK to v16 |
标题规范:
依据 Issue 类型与内容推荐标签:
| 信号特征 | 推荐标签 |
|---|---|
| Bug | bug, needs-repro |
| Feature | enhancement, feature-request |
| 高影响 / 阻塞性问题 | priority:high |
| 需补充信息 | needs-info |
| 适合贡献者入门 | good first issue |
| 安全相关 | security |
| 性能相关 | performance |
| 文档相关 | documentation |
同时建议:
展示完整草稿:
**标题:****类型:** Bug / Feature / Enhancement / Task **推荐标签:** bug, priority:high **推荐 Assignee:** (如已知) --- <完整 Issue 正文> ---
询问:“这样是否合适?我可以调整标题、补充细节,或直接提交。”
提交前提条件:
ghCLI 工具(需已通过gh auth login认证)—— 推荐路径GH_TOKEN环境变量 —— 用于 curl API 回退方案git—— 用于执行git remote get-url origin自动识别仓库第 1–5 步(草稿撰写)无需上述任一工具即可完成。
若用户明确表示“submit”、“create it”、“go ahead”或类似指令,则执行提交:
gh issue create --repo owner/repo --title "" --body " " --label "bug,priority:high" --assignee "@me"
gh 不可用时的回退方案)curl -s -X POST
-H "Authorization: Bearer $GH_TOKEN"
-H "Accept: application/vnd.github+json"
https://api.github.com/repos/{owner}/{repo}/issues
-d '{
"title": "",
"body": " ",
"labels": ["bug"],
"assignees": []
}'
成功时输出 Issue URL;失败时显示响应内容,并提供重试选项。
在向用户呈现草稿前,请确认以下各项:
请务必做到:
# 关联已有 Issue请避免:
.github/ISSUE_TEMPLATE/ 目录