用途
SuperPlane Issue Logger 用于在 SuperPlane 项目中记录议题。当用户以自然语言描述一个改进、缺陷或请求时,该技能负责研究、分类、起草并(可选地)记录议题。
主要能力
-
研究与理解:在 SuperPlane 语境下理解用户描述。参考资料包括 docs/contributing/(issue-tracking、quality、pull-requests、integrations、component-design)以及相关时的 https://docs.superplane.com/(产品行为、UX)。若描述含糊(例如“改进画布”或“修复按钮”),会向用户追问:具体哪里不对或想要什么、发生在应用的哪个位置、期望行为与实际行为,以及(针对 bug)复现步骤。范围上每次只起草一个议题;若用户描述多项,会询问先记录哪一个或分别创建草稿。
-
议题类型分类:将描述映射为以下之一:
- bug:未按预期工作(错误行为、失败、回归)。
- enhancement:对应用中已有功能的小/中型改进。
- feature:全新的功能或能力。
- papercut:小问题、缺陷或不一致;不破坏流程的小改进。 判定规则:破坏流程或阻塞使用 → bug;令人烦扰或不一致但可用 → papercut;改进已有内容 → enhancement;新增净新能力 → feature。与 issue-tracking(SuperPlane Board 上的 Bugs、Papercuts、Enhancements 视图)保持一致。
-
在 tmp/pm_logger 中起草标题与正文:位置为 tmp/pm_logger/(缺失则创建目录),每个议题草稿一个文件(例如 bug-toolbar-copy-button.md、papercut-header-truncation.md)。标题简短,最多 40 个字符,一两个具体概念,既不过于详细也不过于含糊;在文件中以 ### Title(或清晰标题)形式放置,以便记录步骤复用。正文按所选类型使用对应简短模板:
- Bug(简短):Description、Steps to reproduce、Expected / Actual。
- Papercut(极简):What(一句话)、Where(界面/组件与元素)。
- Enhancement(简短):Problem、Current vs proposed、Use case。
- Feature(简短):Describe the request、Describe your use-case、Describe functionality(要点列表)。 截图可选。对于 bug 或 papercut,若用户未提供,会在聊天中询问能否分享截图。聊天中粘贴的截图无法通过 MCP 上传到议题(GitHub API 正文仅接受文本);若用户已在聊天中分享截图,会在正文中注明可在议题创建后粘贴进去,或省略并建议议题打开后添加。不添加空的“Screenshot”小节,不将原始图像数据放入正文。
-
通过 GitHub MCP 记录议题(可选):在用户确认草稿(标题、正文、类型)看起来没问题之前,不会将议题记录到 GitHub。展示草稿、请求验证,仅在用户明确批准(例如“looks good”“log it”“create the issue”)后才创建议题。创建时:从 tmp/pm_logger/<file>.md 读取标题与正文,发送 API 时去掉 ### Title 及正文中的标题行;使用 issue_write(method create)并传入 owner/repo(例如 superplanehq/superplane)、title、body;设置一个类型标签:bug、enhancement、feature 或 papercut(匹配仓库标签;若仓库使用不同名称如 kind: bug,则使用那些);通过 projects_write(add_project_item,item_type: issue、issue_number、item_owner、item_repo)将条目加入 SuperPlane Board(project 2)。不设置 Integration Status(那是用于集成议题的)。按顺序创建议题以避免速率限制。可选在 tmp/pm_logger/log-progress.md 保留简短进度说明,并在用户确认后仅删除进度文件(保留草稿文件,除非用户要求删除)。议题创建后,建议用户附加视频(例如屏幕录制)到议题,通过添加带链接的评论或上传,以帮助分类与实现。
使用方式
当用户用自然语言描述 SuperPlane 的改进、缺陷或请求时触发。技能按“研究理解 → 分类 → 起草 → 用户确认 → 可选记录”的流程执行。
适用场景
适用于 SuperPlane 项目中记录 bug、enhancement、feature、papercut 类议题,尤其是需要将自然语言描述整理为规范议题草稿并同步到 GitHub 与 SuperPlane Board 的场景。
限制
- 每次只起草一个议题。
- 标题最多 40 个字符。
- 聊天中粘贴的截图无法通过 MCP 上传到议题正文。
- 未经用户明确确认不会在 GitHub 创建议题。
- 不设置 Integration Status。
- 需按顺序创建议题以避免速率限制。