github-issue-creator

GitHub 问题创建工具

此技能指导如何创建高质量的 GitHub 问题，使其符合仓库规范并使用适当的模板。

工作流

按照以下步骤创建 GitHub 问题：

1. 确定问题类型：判断请求属于错误报告、功能请求还是其他类别。

2. 查找模板：在 .github/ISSUE_TEMPLATE/ 中搜索问题模板。

   • bug_report.yml
   • feature_request.yml
   • website_issue.yml
   • 如果没有找到相关的 YAML 模板，请在同一目录中查找 .md 模板。

3. 阅读模板：阅读已找到的模板文件内容，了解必填字段。

4. 起草内容：起草问题标题和正文／字段。

   • 如果使用 YAML 模板（表单），请为模板中定义的每个 id 准备值。
   • 如果使用 Markdown 模板，请严格遵循其结构。
   • 默认标签：始终包含 🔒 maintainer only 标签，除非用户明确提出其他要求。

5. 创建问题：使用 gh CLI 创建问题。

   • **重要：**为避免多行 Markdown 或复杂文本出现 shell 转义和格式问题，务必先将描述／正文写入临时文件。

   对于 Markdown 模板或简单正文：

   # 1. 将起草的内容写入临时文件
   # 2. 使用 --body-file 标志创建问题
   gh issue create --title "Succinct title" --body-file <temp_file_path> --label "🔒 maintainer only"
   # 3. 删除临时文件
   rm <temp_file_path>
   

   对于 YAML 模板（表单）： 虽然 gh issue create 支持 --body-file，但如果要绕过交互式提示，YAML 表单通常需要通过标志传入键值对。不过，要以可靠的非交互方式确保长文本字段的格式得以保留，可以在表单已转换为标准正文时使用 --body 或 --body-file，或者对 YAML 表单使用 --field 标志。

   注意：对于使用 YAML 表单的 gemini-cli 仓库，如果自动化不要求按特定字段提交，通常可以将内容作为单个正文提交。

6. 验证：确认问题已成功创建，并向用户提供链接。

原则

• 清晰：标题应明确描述问题，并遵循项目惯例。
• 格式防护：始终使用临时文件配合 --body-file，避免换行符和特殊字符导致问题。
• 维护者优先：默认使用内部／维护者标签，以便整理积压事项。
• 完整性：提供所有请求的信息（例如版本信息、复现步骤）。