| name | qiniu-create-pr |
| description | 在用户指定的项目根目录根据内置默认模板组装 PR 说明(默认写入 PR_SUMMARY.md),Summary 原样保留,在 What changed 下为每个引用文件追加规范列表项,并根据 test.txt 的 命令/结果 对生成 Testing 节;无内容时整节删除。可选覆盖模板。最后一步:以 Markdown 形式输出完整文档(含于用户可见回复),并删除项目根下的 PR_SUMMARY.md 与 test.txt(若存在)。适用于按模板输出根目录变更说明、What changed、Testing、七牛 Qiniu provider 变更说明时。 |
按模板生成根目录变更说明
内置默认模板
生成文档时默认以下模板为唯一结构来源(Summary 节一字不改)。仅当用户在本轮对话中粘贴或给出路径提供替换模板时,改用用户模板。
## Summary
Added support for Qiniu AI (七牛云) as a new model provider.
## What changed
## Testing
```
```
说明:## What changed 与 ## Testing 之间的空行保留;最终写入文件时,若无需 Testing 节则按规则整节删除(含围栏),不保留空代码块。
何时使用
在以下情况应用本 skill:
- 用户指定目标项目根(或默认当前工作区根),要在该根下生成一个 Markdown 文件。
- 用户引用了若干文件,并需要按规范在 What changed 下逐条列出。
- 用户需要从 test.txt 填充 Testing,或在无内容时去掉该节。
输出与临时文件
- 中间写入:默认先将完整文档写入
<项目根>/PR_SUMMARY.md(Markdown);若用户在同一次对话中指定了其他文件名,则写入 <项目根>/<该文件名>。
- 最后交付:在删除文件前,将同一套完整 Markdown 内容输出到用户可见回复中,便于粘贴到 PR 等场景。
- 收尾删除:完成上述输出后,删除项目根下的
PR_SUMMARY.md 与 test.txt(若存在;若用户指定了非默认文件名,仅删除本次写入的该文件与 test.txt)。
规则
Summary(禁止修改)
- 使用当前选用的模板(默认即上一节内置模板)中的整个
## Summary 节原样输出——不得改字、空格或标点。
What changed
- 在
## What changed 标题下方,为本次工作流中用户引用/附加的每个文件各写一行(保留模板中标题后的空行习惯)。
- 每行严格使用以下格式(路径与 作用 之间为 一句简短英文,说明该文件在变更中的角色):
- `相对或绝对路径` - One short English sentence describing the file's role.
- 根据路径、文件内容或对话推断作用;路径优先使用相对仓库根的路径,正斜杠。
Testing 与 test.txt
- 若存在则读取
<项目根>/test.txt。
- 严格解析:成对出现的
命令: 行与 结果: 行(与 qiniu-test-record skill 写入格式一致)。去掉 命令: / 结果: 前缀并 trim。
- 对每一对,在
## Testing 下反引号代码块内输出一段:
<命令行内容>
# <结果行内容>
- 多对:各段之间用一个空行分隔。
- 若
test.txt 不存在、为空或没有可解析的 命令:/结果: 对:整段不要输出 ## Testing(含其下的 ``` 围栏),不要留空节或空代码块。
模板来源(优先级)
- 默认:使用本文 「内置默认模板」 节的全部内容。
- 覆盖:用户在同轮对话中粘贴完整模板或给出文件路径时,使用用户模板(仍须遵守 Summary 不编辑、仅复制模板中的 Summary 原文)。
边界情况(非标准 test.txt)
- 若
test.txt 不是 命令:/结果: 形式,不要猜测。除非用户在同一条消息中明确要求原样转储或说明另一套映射规则,否则省略 Testing。
工作流程
- 向用户确认或使用默认的项目根(显式路径或当前工作区根)。
- 选用模板:无用户提供则采用 内置默认模板;否则读取用户粘贴或路径对应文件。
- 组装文档:
- Summary:与所选模板中的 Summary 完全一致。
- What changed:保留模板中的该节标题 + 空行习惯 + 仅追加引用文件的列表行(除非用户同轮明确要求补充其他正文)。
- Testing:按上文规则从
test.txt 生成;若无内容则从输出中删除整个 ## Testing … ``` 块。
- 使用默认或用户指定的文件名将完整文档以 Markdown 写入项目根。
- 最后:在用户可见回复中输出与写入文件一致的完整 Markdown(即 PR 说明正文);随后删除项目根下的
PR_SUMMARY.md(或用户指定的输出文件名)与 test.txt(若存在)。
自检清单