Please describe the changes in your PR. If it is addressing an issue, please reference that as well.
Please describe the changes in your PR. If it is addressing an issue, please reference that as well.【免费下载链接】pipecatOpen Source framework for voice agents, multimodal apps, and realtime AI. Maintained by Daily and the community.项目地址: https://gitcode.com/GitHub_Trending/pi/pipecat也就是说如果贡献者创建 PR 时没有手动填写描述PR 描述就停留在这一行模板文本上这正是 /pr-description 需要接管的情形。 ### 第三步分析变更内容 这一步把 diff 转化为语义层面的结论规则包括 - 理解**每个 commit 的意图**结合 git log main..HEAD --oneline 的提交信息 - 识别**破坏性变更**API 变更、被移除的功能、行为变化 - 归类为**新功能、Bug 修复、重构或文档变更**之一或若干 - 收集 Issue 编号来源有两个 - --fixes 参数如果提供 - commit message 中符合约定模式的文本例如 Fixes #123、Closes #456、Resolves #789。 值得注意的是从 commit message 收集时使用“Fixes / Closes / Resolves”多种模式做**输入**匹配但输出到描述时会被统一规整见下一节的 Fixes 规范。 ### 第四步生成或更新描述 描述输出为固定的四段式结构各段有明确的包含条件。 #### Summary必须包含 用简短的要点说明“改了什么、为什么改”聚焦**目的与影响**而非实现细节 markdown ## Summary - Added X to enable Y - Fixed bug where Z would happen - Refactored W for better maintainabilityBreaking Changes仅在有破坏性变更时包含记录所有影响既有用户或 API 的变更## Breaking Changes - ClassName.method() now requires a param argument - Removed deprecated old_function() - use new_function() insteadTesting在验证方式不明显时包含说明如何验证变更有效琐碎变更可跳过## Testing - Run uv run pytest tests/test_feature.py to verify the fix - Example usage: uv run examples/new_feature.pyFixes在提供了 Issue 或从 commit 中发现 Issue 时包含列出本 PR 修复的 Issue。GitHub 在 PR 合并时会依据这些引用自动关闭对应 Issue## Fixes - Fixes #123 - Fixes #456技能对此有一条明确的措辞规范统一使用 Fixes #X 格式而不是 Closes 或 Resolves并且每个 Issue 单独一行、前缀固定为 Fixes以确保 GitHub 的自动关闭行为一致可预期。这与第三步中“从 commit message 匹配多种模式”形成对照——输入宽容、输出严格。写作准则30 秒可读、讲 why 不讲 what技能在 Guidelines 部分给出了五条写作准则直接决定最终描述的质量准则含义Be concise评审者应在 30 秒内理解这个 PRFocus on whydiff 已经展示了“改了什么”描述要解释“为什么改”Skip empty sections只保留有内容的章节不为凑格式而留空节Use bullet points要点列表比段落更易扫读Dont duplicate the diff不要罗列每一个改动文件和行这些准则并非孤立要求而是 Pipecat 仓库统一写作标准的延伸。技能的 Checklist 第一行写道Description documents the change for users, not the development process — the standard/prose-reviewapplies, inAGENTS.mdunder Writing for Future Readers对应 AGENTS.md 的 “Writing for Future Readers” 章节其核心原则是为代码库的未来读者写作而不是为当下参与协作的人写作——“留下当前时刻之外的东西”剔除只在工作进行中才有意义的上下文且每一句话都必须回答“代码现在做了什么”而不是“我们当时经历了什么”。PR 描述作为面向用户和评审者的发布说明正是这一标准的应用面而具体执行层面则交由 prose-review 技能做操作性检查。完整示例技能给出的输出样板技能文档末尾附了一个完整的输出示例展示了各章节如何协同## Summary - Added /docstring skill for documenting Python modules with Google-style docstrings - Skill finds classes by name and handles conflicts when multiple matches exist - Skips already-documented code to avoid unnecessary changes ## Testing /docstring ClassName ## Fixes - Fixes #123这个示例同时体现了三条准则Summary 三点分别讲能力、边界处理与防重复why 与 impactTesting 章节只给了一条最短验证命令描述中出现的是面向用户的行为而不是开发过程叙事。更新前的自检清单技能要求在提交描述更新前逐项核对- [ ] Description documents the change for users, not the development process — the standard /prose-review applies, in AGENTS.md under Writing for Future Readers - [ ] Verified existing description needs updating (not already complete) - [ ] Summary accurately reflects the changes - [ ] Breaking changes are clearly documented (if any) - [ ] No unnecessary sections included - [ ] Description is concise and scannable【免费下载链接】pipecatOpen Source framework for voice agents, multimodal apps, and realtime AI. Maintained by Daily and the community.项目地址: https://gitcode.com/GitHub_Trending/pi/pipecat创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考
上一篇/下一篇内容由系统自动关联
返回资讯列表 →