关于 pr-writing
pr-writing 是根据代码仓库本地上下文起草 Pull Request 标题和正文的技能,面向需要整理变更说明的开发者。它按项目配置选择模板,并要求每项陈述都有依据,未知信息须明确标注。
主要功能
- 01仓库辅助脚本
- 02按项目配置起草 PR
- 03基于工单的标题规则
- 04说明与测试章节
- 05标注未知信息
适用场景
- 01根据分支变更起草 PR
- 02为前端 PR 添加截图章节
- 03编写关联工单的 PR 标题
安装
复制下面的命令,在终端中运行。
$
npx skills add https:/ / github.com/ darknesskiller/ skills --skill pr-writing安装后在 Claude Code 中输入/pr-writing确认已加载。
包含的文件
除 SKILL.md 外,安装时一起下载的参考资料和脚本。
agents/openai.yamlscripts/pr_writer.pytest_cli.py详细介绍
PR 撰写
辅助脚本位于相对于此技能目录的 scripts/pr_writer.py(由运行环境解析)。从用户的仓库中使用脚本的绝对路径或相对于技能目录的路径运行:
python3 <skill-dir>/scripts/pr_writer.py
步骤
- 运行辅助脚本或检查分支。完成标准:已知源、目标、提交和变更文件。
- 检测配置文件或接受
--profile。使用 Description、Test Plan、Test Result、Links 起草。仅对frontend添加 Screenshot。 - 撰写标题。
feat表示新增行为,fix表示修复问题,refactor表示重构。分支或提交中有工单:<feat|fix|refactor> [TICKET-123]: 简洁描述。没有工单:<feat|fix|refactor> (feature-name): 简洁描述。 - 每项说明都必须有本地上下文作为依据。未知信息须标注,不得编造。
完成标准:标题符合工单规则,正文包含适用的标题,配置文件与仓库匹配,未知信息已标注。
命令
draft --repo-dir . [--target main] [--format toon] [--profile frontend]
配置文件
| 信号 | 配置文件 |
|---|---|
| React、Next、Vue、Nuxt、Svelte、Angular、Astro、Preact、React Native | frontend |
Flutter pubspec.yaml | frontend |
Dart pubspec.yaml | dart |
go.mod | go |
| 无 | generic |
评论
支持 Markdown