mcpField
G
github-issues

github-issues

github.com/epicenterhq开发4.8k66 次安装3 周前更新
代码仓库

关于 github-issues

为 GitHub Issue 和 PR 回复提供写作规范,面向项目维护者及参与讨论的开发者。重点是简洁、贴合语境的回复,并包含致谢、澄清问题和调试邀请等建议。

主要功能

  1. 01避免冗长和公式化回复
  2. 02按问题语境调整开场语气
  3. 03简洁说明修复状态和后续行动
  4. 04提供澄清与调试沟通建议
  5. 05涵盖 Issue 和 PR 回复示例

适用场景

  1. 01回复已修复问题并说明状态
  2. 02向报告者询问复现信息
  3. 03回应 PR 讨论中的具体变更
  4. 04为复杂问题提出协同调试

安装

复制下面的命令,在终端中运行。

$npx skills add https://github.com/epicenterhq/epicenter --skill github-issues

安装后在 Claude Code 中输入/github-issues确认已加载。

详细介绍

GitHub Issue 和 PR 评论指南

反模式(请避免)

  • 结构过于繁琐:简单回复不要使用标题、编号章节或项目符号列表。通常用一段对话式文字更合适。
  • 公式化开场:不要每条评论都用相同的方式开头。语气应与对话相符。
  • 复述显而易见的内容:有人提出问题时,直接回答即可。不要重复对方说过的话。
  • 企业公告式措辞:“我们很高兴地宣布……”;直接说明发生了什么变化即可。
  • 过度解释已解决的问题:如果问题已解决,且报告者无需采取任何行动,就不要让他们阅读发布流程的细节。

语气请遵循 writing-voice。

尊重维护者原则

请假设问题报告者和维护者都很忙。通常,最尊重对方的评论就是用最简短的方式清楚地说明问题已处理完毕。

评论精简规则

起草前请先问自己:读者需要知道什么或接下来需要做什么?只包含这些内容。

大多数评论可以采用以下结构:

  1. 表示理解。
  2. 说明当前状态或直接回答。
  3. 仅在有下一步行动时说明。
  4. 友好收尾。

友好之意应自然流露,但不必过多。最好在开场或结尾句末尾使用一个感叹号。通常结尾是最合适的位置:“再次感谢你发现这个问题!”

除非读者需要这些信息来核实答复或采取下一步行动,否则不要添加内部流程细节。

已修复的问题

对于已修复的问题,请按以下顺序回复:

  1. 感谢对方指出问题。
  2. 直接说明当前状态。
  3. 仅在有助于对方核实时,提及具体版本、发布版本、PR 或提交。
  4. 简短致谢收尾,通常加一个感叹号。

除非有助于回复,否则不要强调报告者的判断正确。通常只需表示感谢并说明当前状态。除非问题涉及内部机制,或用户需要了解这些信息来核实修复,否则不要解释内部机制。

示例:

Hey @username, thank you for flagging this.

This has been fixed, and current releases now include npm provenance attestations.

Thanks again for catching it!

开场方式

在讨论串中首次回复时,请使用用户的 GitHub 用户名进行个性化问候(后续来回交流时可以省略):

  • “嗨,@username,感谢你提交问题”
  • “大家好,感谢提醒!”
  • “各位好,感谢你们提出这个问题!”

核心要素

1. 表示理解
  • 开头先回应对方提出的问题或作出的贡献
  • 对遇到的问题表达同理心:“很遗憾听到这个消息!”、“很遗憾你的快捷方式丢失了!”
  • 对延迟回复表示歉意:“很抱歉回复晚了”
2. 传达好消息

宣布功能或修复时:

  • 使用“好消息!”或“Good news!”
  • 酌情少量使用庆祝表情符号
  • 致谢贡献者:“感谢你带来的启发”或“感谢你和 @user1、@user2 带来的启发”
3. 提供调试帮助

对于复杂问题,主动提供直接帮助:

  • “如果你有时间,我很乐意和你通个电话,我们可以一起调试”
  • “我们这几天找个时间通个电话吧,我来和你一起调试”
  • 邀请通话时,请附上 cal.com 链接:“https://cal.com/epicenter/whispering”
  • 不要承诺无法确认的具体时间安排(例如“我最早明天有空”)
4. 推荐 Discord

如果报告者看起来积极参与了项目,可以偶尔邀请他们加入 Discord:

  • “附言:我最近还建了一个 Discord 群组,欢迎你加入!你可以直接联系我,提出更多功能需求。”
  • 附上链接:“https://go.epicenter.so/discord”
5. 后续提问

提出澄清问题,以便更好地了解问题。询问缺少的信息:确切版本、平台,以及最精简的复现步骤。

  • “想确认一下,即使使用最新的安装程序,这个问题仍然存在吗?”
  • “你能告诉我你使用的操作系统和版本吗?”
6. 结尾

以感谢收尾:

  • “谢谢!”
  • “再次感谢!”
  • “再次感谢你的帮助,我会看看这个问题!”
  • “不客气!”(在对方致谢时)

回复示例

功能实现回复
Hey @username, thank you for the issue, and good news! [The latest release](link) now includes the [feature]! Thank you for the inspiration.

[Brief description of how it works]

PS: I've also recently created a Discord group, and I'd love for you to join! You can ping me directly for more features.

https://go.epicenter.so/discord
调试回复
Hey @username, so sorry to hear this! I apologize for the delayed response; I was finalizing [the latest release](link).

To clarify, could you confirm that this issue persists even with the latest installer?

If you have time, I would love to hop on a call with you, and we can debug this together. You can book a meeting with me using my cal.com link right here:

https://cal.com/epicenter/whispering

Thank you!
快速确认
Hey @username, sorry to hear [problem]! Did you ever get a fix?
PR 讨论(来回交流)
Good catch! Updated to only clear the dev app cache in nuke mode.

The flow is now:
- `bun clean`: artifacts and node_modules
- `bun nuke`: above + Rust targets + dev cache

Let me know if you want a confirmation prompt before clearing.

写作风格说明

  • 提及具体用户并致谢;链接到相关议题、版本发布或提交
  • PR 评论可以简短:持续进行的讨论不需要完整的问候和结束语
  • 语气与内容相匹配:简短的问题简短回答,详细的报告详细回复

评论

支持 Markdown