GitHub PR Writer

自动生成结构化 GitHub Pull Request 描述,提升代码审查效率。

已扫描
适合谁
开发人员、技术负责人
不适合谁
非开发者、无 Git 操作经验者
国内可用性
需网络配置。可能需要网络配置或第三方服务可访问。
安装难度
新手友好(★☆☆)。基于终端操作、依赖、API Key 和本地环境要求的初步判断。

安装与下载

openclaw skills install @djc00p/github-pr-writer

Skill 说明

命令、参数、文件名以原文为准

GitHub PR Writer

使用一致的模板生成结构清晰、内容详尽的 PR 描述。

模板

请参阅 assets/pull_request_template.md 以获取完整的模板,可复制到仓库的 .github/pull_request_template.md 文件中。

如何填写

撰写 PR 描述前,请先收集相关信息:

# 查看与主分支相比的变更文件及数量
git diff main --stat

# 查看提交信息
git log --oneline main..HEAD

# 查看完整差异(适用于较小的 PR)
git diff main

然后逐项填写以下各部分:

摘要

一两句话说明此 PR 的目的和原因。如有相关问题,请附上链接。

Closes #123
通过 Devise 实现用户认证并支持邮箱确认。

变更类型

仅勾选一个(或两个,若确实适用)。保持诚实——若有破坏性变更,请勿勾选“安全”。

实现 / 修复

链接相关问题或具体描述本 PR 解决的功能/缺陷。描述需足够具体,以便审阅者清楚应关注哪些内容。

变更详情

使用项目符号列出代码中实际发生的变化:

  • 新增的文件
  • 修改的现有文件及其原因
  • 删除的内容
  • 配置变更
  • 数据库迁移

将相关变更归类在一起。优先列出最重要的变更。

影响范围

如实评估。若修改了共享组件、基础类或影响应用多个部分,请明确标注。

测试说明

告知审阅者如何验证更改是否生效:

  • 增加或修改的测试用例
  • 如需手动 QA 的步骤
  • 考虑过的边界情况
  • 有意未测试的内容及其原因

规则

  • 每个部分都必须填写 —— 留空表示未完成,可能引发审查延迟
  • 勾选合适的复选框 —— 不得全部留空
  • 变更详情需具体明确 —— “更新了一些内容”无实际意义
  • 影响范围需真实反映 —— 审阅者需要知道应重点关注什么
  • 禁止直接合并 —— PR 用于评审;由作者或维护者完成合并

示例(已填写)

# 📦 Pull Request

## 摘要
Closes #44
为乘车预订系统添加司机可用性功能。当乘客发起乘车请求时,系统会根据排班时段、已有行程冲突以及行驶时间缓冲,检查已批准司机的可用状态。

---

## ✅ 合并前检查清单
### 代码
- [x] 本地运行无错误
- [x] 代码中无未使用的或注释掉的代码段
- [x] 已完成代码审查
- [x] 复杂逻辑处已添加注释

### 测试
- [x] 所有测试均通过
- [x] 已按需添加或更新测试

---

## 🧪 变更类型
- [x] 🚀 新功能

---

## 🛠️ 实现 / 修复
实现第一阶段乘车调度中的司机可用性检查功能。

---

## 📋 变更详情
- 在 `user_rides` 表中新增 `role` 字段(driver/patron,默认:patron)
- 创建 `driver_schedules` 表,用于管理重复或单次的可用时间段
- 添加 `DriverSchedule` 模型及 `covers_time?` 方法
- 添加 `GeoapifyDriveTimeService`,通过 Geoapify Route Matrix API 获取实时行驶时间
- 添加 `DriverAvailabilityService` —— 四步可用性检查逻辑
- 更新种子数据和工厂定义,包含 `role` 字段

---

## 💣 影响范围
- [x] 此 PR 是安全的(不破坏现有功能)

---

## 🧪 测试说明
- [x] 大部分/所有测试已更改

共新增 75 个测试,分布在 3 个 spec 文件中。最终测试套件:729 个示例,0 个失败。
D
@djc00p

已收录 4 个 Skill

相关推荐