自动从 git diff 和提交历史生成 Pull Request 描述,解析常规提交并对变更进行分类(功能、修复、重构等)。
PR 描述生成器 : 自动生成结构化的 PR 描述来自 git diffs 并承诺历史.是一项面向实际任务的技能,主要用于Pure Python + git CLI.;QQ 快速启动.;
它将相关步骤、工具调用和结果整理方式集中到统一流程中,帮助使用者更快完成目标并减少重复操作。使用时应结合输入条件选择合适的执行方式,核对必要参数、依赖环境与输出内容,并按原始要求处理异常情况。从功能定位来看,该技能强调把分散的操作要求整理成清晰、可复用的处理流程,使用户能够围绕既定目标快速准备输入、选择执行方式并获得结构化结果。实际使用前应先确认任务范围、数据来源、运行环境、必要权限和关键参数,再依据技能说明逐步执行;
若输入条件不完整,应先补齐信息或采用保守配置,避免因错误假设导致结果偏离需求。执行过程中需要关注工具调用是否成功、接口或依赖是否可用、输出格式是否符合预期,并对异常提示、缺失字段和边界情况进行处理;涉及批量任务时,还应保存进度,避免中断后重复操作。该技能适合用于一次性任务,也可以接入自动化工作流,与其他技能或上层代理配合完成更完整的业务链路;在组合使用时,应明确每一步的输入输出关系,并避免不同步骤之间出现参数冲突。
基于 git 差异(diff)和提交历史,自动生成结构化的 PR 描述。纯 Python 实现,依赖 git CLI。
# 标准描述(当前分支与 main 的对比) python3 scripts/generate_pr_description.py # 与指定基线分支对比 python3 scripts/generate_pr_description.py --base develop # 极简模板(仅项目符号列表) python3 scripts/generate_pr_description.py --template minimal # 详细模板(含文件分类 + 审阅者提示) python3 scripts/generate_pr_description.py --template detailed # JSON 输出(适用于自动化流程) python3 scripts/generate_pr_description.py --format json # 指定其他仓库路径 python3 scripts/generate_pr_description.py --repo /path/to/repo # 保存至文件 python3 scripts/generate_pr_description.py --output pr-body.md # 复制到剪贴板 python3 scripts/generate_pr_description.py --copy
| 模板 | 适用场景 |
|---|---|
minimal |
快速摘要,内部 PR |
standard |
默认模板,适用于大多数 PR |
detailed |
大型 PR、跨团队评审 |
当提交信息遵循约定式格式时,效果最佳:
feat(auth): add OAuth2 login fix(api): handle null response from payment gateway refactor: extract validation into shared utility docs: update API reference for v2 endpoints
不符合约定式格式的提交将统一归入“其他变更”类别。
相关专题
热门下载
相关下载
精品课程
共6课时 | 54.7万人学习
共89课时 | 134.1万人学习
共49课时 | 82.6万人学习
最新文章