关于 messaging-framework
messaging-framework 为开发者提供编写提交信息、PR 描述、分支名和技术文档的原则。它以真实问题及其后果组织内容，并按不同产物规定格式与长度。
主要功能
- 01围绕实际痛点组织信息
- 02按问题及后续影响撰写
- 03为提交和 PR 规定格式
- 04提供分支命名与长度规范
- 05列出常见写作反模式
适用场景
- 01撰写清晰的提交主题和正文
- 02描述 PR 中的问题及方案
- 03命名开发分支
- 04编写技术文档
安装
复制下面的命令，在终端中运行。
$
npx skills add https:/安装后在 Claude Code 中输入/messaging-framework确认已加载。
详细介绍
消息编写框架
编写提交信息、PR 描述、分支名称和技术文档的核心原则。
两个目标
| 目标 | 用途 |
|---|---|
| 传达信息 | 帮助读者理解并记住这项工作的内容 |
| 说明价值 | 阐明这项工作的价值，让审查投入显得值得 |
痛点模式
只围绕真实痛点组织消息：
- 观察到的问题
- 后续影响
PR 正文不要过多描述解决方案。审查者会检查差异。不要仅仅为了重述改动中已有的内容而添加测试计划章节。
痛点应描述真实体验，例如错误、重复的工作流、成本高昂的流程或令人困惑的行为，以及相应的后果。
| 不佳 | 良好 |
|---|---|
| “没有通用接口” | “本地开发编排在不同环境中重复实现，导致各份副本逐渐不一致” |
| “丢失错误上下文” | “后端故障被映射到了错误的结果，因此技术错误看起来像业务结果” |
句式结构
优先采用：
- “通过某种机制实现某项
收益” - “为实现某项收益而
采取某种机制”
示例：
- “通过自动配置和日志格式化加快本地开发”
- “通过修复资源同步竞争条件防止数据丢失”
按制品确定格式
| 制品 | 格式 | 长度 |
|---|---|---|
| 分支名称 | TICKET/short-description | 短 |
| 提交主题 | TICKET: type(scope): verb benefit by mechanism | <=100 个字符 |
| 提交正文 | 仅描述痛点 | 中 |
| PR 标题 | 与提交主题相同 | 短 |
| PR 描述 | 痛点加一句话说明方案 | 中 |
反模式
- “添加功能”
- “修复错误”
- “重构代码”
- “更新依赖项”
- PR 正文中的解决方案清单
- 用泛化抽象取代观察到的问题
评论
支持 Markdown