用途:把零散的缺陷报告、功能请求、支持记录或 PR 内容,整理成一份简短、通俗、聚焦问题与期望行为的问题描述,让维护者能在一分钟内看懂。
主要能力:读取提供的笔记、对话、issue、PR 描述或 diff;在 PR 中还会查看规格、设计文档或 README 变更,因为这些往往比描述更能说明意图。识别具体问题,说明受影响的对象;描述期望行为而不规定实现方式;只保留有助于理解或复现问题的上下文。若来源是 PR 或 diff,则描述该改动试图解决的问题,而非改动的文件或代码。
使用方式:除非无法确定问题与期望行为,否则直接起草;无法确定时只问一个简短的澄清问题。一个问题对应一个 issue;若来源混杂多个不相关问题,只为最重要的一个起草,其余各列一行,并建议贡献者拆分为独立 issue 和 PR。若来源是新增能力而非修复错误,不要把缺失写成 bug,而应描述用户当前无法做什么以及该功能的完整体验。不得编造用户影响、复现步骤或来源不支持的确定性;若来源只是清理、重构或疑似代码坏味,应说明没有明确的具体问题,并给出两到三句话说明来源展示了什么、需要什么证据才值得开 issue。若来源修复的是尚未公开的安全弱点,不要起草公开 issue,建议私下报告给维护者。
写作规则:使用通俗语言和短句;除非复现步骤或大型功能确有必要,控制在 200 词以内;以行为开头,而非代码、架构或拟议修复;仅在复现或理解问题时保留技术细节;保留错误信息、截图、链接和文档引用等有用证据;不要提及 AI 撰写或审阅;避免填充、赞美、路线图语言和穷举边界情况;沿用贡献者的确定程度,猜测不要写成已确认的 bug。
输出格式:首行为标题(在 GitHub 提交时放入标题字段);缺失能力应标题化结果而非伪造 bug。结构为标题、TL;DR、What is happening?、What should happen?、可选的 Extra context。
限制:资料未提供具体平台、收费、价格或效果信息。