自动创建PR与双语文档同步技能 - 代码提交与文档更新自动化

create-pr by charon-fan/agent-playbook

166 周安装量

23 GitHub Stars

GitHub

安装命令

npx skills add https://github.com/charon-fan/agent-playbook --skill create-pr

自动化开发运维技术文档

🇨🇳中文介绍

创建 PR

一个用于创建拉取请求并自动更新双语文档的技能。该技能确保在提交代码变更时，英文和中文文档保持同步。

此技能何时激活

当您执行以下操作时，此技能将激活：

要求创建拉取请求或 PR
说"提交我的更改"或"推送并创建 PR"
提及"制作一个 PR"或"打开一个拉取请求"
希望提交代码进行审查

PR 创建工作流程

步骤 1：分析变更

检查当前分支中的所有变更：

git status
git diff
git log --oneline main..HEAD

识别：

修改的文件：更改了什么？
新文件：添加了什么？
删除的文件：移除了什么？
影响范围：哪些技能或功能受到影响？

步骤 2：确定文档更新

检查技能变更

首先，检测是否有任何技能被更改：

# 检查 skills/ 目录是否有变更
git diff --name-only main..HEAD | grep "^skills/"

决策矩阵

变更类型	文档操作

广告位招租

在这里展示您的产品或服务

触达数万 AI 开发者，精准高效

联系我们

自动触发变更需要更新

如果技能的 metadata.hooks 前置元数据被修改，技能目录中的自动触发列必须更新：

# 检查钩子是否被修改
git diff main..HEAD -- skills/*/SKILL.md | grep -E "^\+.*metadata:|^\+.*hooks:|^\+.*trigger:"

如果钩子已更改 → 更新 README.md 和 README.zh-CN.md 中的自动触发列。

步骤 3：起草提交消息

使用 commit-helper 格式：

<type>(<scope>): <subject>

<body>

<footer>

feat：新技能或功能
fix：错误修复或更正
docs：仅文档更改
refactor：代码重构
chore：维护任务

步骤 4：创建拉取请求

运行以下序列：

# 1. 暂存并提交更改
git add .
git commit -m "commit message"

# 2. 推送到远程
git push -u origin <branch-name>

# 3: 使用 gh CLI 创建 PR
gh pr create \
  --title "PR title" \
  --body "PR description"

步骤 5：更新文档（如果需要）

创建 PR 后，更新两个 README 文件：

README.md（英文）：

将新技能添加到适当的类别表中
如果需要，更新项目结构
保持顶部的语言切换链接

README.zh-CN.md（中文）：

镜像所有英文更改
翻译技能描述
保持相同的结构和格式

步骤 6：更新变更日志（可选）

对于重大更改，添加到 CHANGELOG.md：

## [版本] - YYYY-MM-DD

### 新增
- 新技能：skill-name

### 修复
- 修复了 skill-name 中的问题

### 更改
- 使用新功能更新了 skill-name

技能目录更新模板

添加或修改技能时，请使用此格式更新技能目录：

英文（README.md）：

### 类别名称

| Skill | Description | Auto-Trigger |
|-------|-------------|--------------|
| **[skill-name](./skills/skill-name/)** | 简短描述 | Manual / Auto / Background / (keyword: "...") |

中文（README.zh-CN.md）：

### 类别名称

| 技能 | 描述 | 自动触发 |
|------|------|----------|
| **[skill-name](./skills/skill-name/)** | 简短描述 | 手动 / 自动 / 后台 / (关键词："...") |

值	含义	示例
`Manual`	用户必须调用	大多数开发技能
`Auto`	在任何技能后自动触发	session-logger
`Background`	在相关技能后非阻塞运行	self-improving-agent
`After skill updates`	仅在技能被修改时触发	create-pr
`(keyword: "...")`	在特定关键词上激活	prd-planner (keyword: "PRD")

始终在以下情况更新：

添加新技能
移除技能
更改技能名称或描述
重构技能目录结构

考虑在以下情况更新：

为现有技能添加重要功能
更改安装说明
修改项目结构

在以下情况跳过更新：

不影响用户的内部代码重构
次要的拼写错误修复
测试文件更改

向技能表添加新技能时：

英文（README.md）：

| **[skill-name](./skills/skill-name/)** | 简短技能描述 |

中文（README.zh-CN.md）：

| **[skill-name](./skills/skill-name/)** | 技能简短描述 |

两个 README 文件顶部都必须有语言切换链接：

English | [简体中文](./README.zh-CN.md)

README.zh-CN.md：

[English](./README.md) | 简体中文

创建 PR 时，请使用此模板：

## 摘要

<此 PR 功能的简要描述>

## 变更

- [ ] 添加了新技能
- [ ] 修改了现有技能
- [ ] 更新了文档
- [ ] 添加/更新了测试

## 受影响的技能

- `skill-name`：变更描述

## 文档

- [x] README.md 已更新
- [x] README.zh-CN.md 已更新
- [ ] CHANGELOG.md 已更新（如果适用）

## 测试计划

- [ ] 在 Claude Code 中测试了技能
- [ ] 验证了文档链接
- [ ] 检查了双语翻译

---

🤖 由 [Claude Code](https://claude.com/claude-code) 生成

场景 1：添加新技能

# 1. 创建技能文件
mkdir -p skills/new-skill
touch skills/new-skill/SKILL.md
touch skills/new-skill/README.md

# 2. 创建符号链接
ln -s ~/path/to/agent-playbook/skills/new-skill/SKILL.md ~/.claude/skills/new-skill.md

# 3. 更新 README.md（添加到技能表）
# 4. 更新 README.zh-CN.md（添加到技能表并翻译）

# 5. 提交并推送
git add skills/new-skill/ README.md README.zh-CN.md
git commit -m "feat: add new-skill for ..."
git push -u origin feature/add-new-skill

# 6. 创建 PR
gh pr create --title "feat: add new-skill" --body "..."

场景 2：修改现有技能

# 1. 对技能进行更改
vim skills/existing-skill/SKILL.md

# 2. 检查描述是否更改
git diff skills/existing-skill/SKILL.md

# 3. 如果描述已更改，更新 README 文件
# 4. 提交、推送、创建 PR

场景 3：仅错误修复

# 1. 修复错误
vim skills/some-skill/SKILL.md

# 2. 提交并推送（无需更新 README）
git add skills/some-skill/SKILL.md
git commit -m "fix: correct typo in some-skill"
git push

# 3. 创建 PR
gh pr create --title "fix: correct typo in some-skill"

创建 PR 前，请验证：

所有更改都已提交
分支已推送到远程
提交消息遵循约定式提交
如果需要，README.md 已更新
如果需要，README.zh-CN.md 已更新
两个 README 中都存在语言切换链接
新技能已创建符号链接
PR 标题清晰且具有描述性
PR 描述包含摘要和变更

命令	用途
`git status`	检查当前状态
`git diff`	查看未暂存的更改
`git log main..HEAD`	查看分支提交
`git add .`	暂存所有更改
`git commit -m "msg"`	提交并附带消息
`git push -u origin branch`	推送到远程
`gh pr create`	创建拉取请求

先提交，后 PR：始终在创建 PR 前提交更改
小型 PR：保持 PR 专注于单一变更
清晰的标题：在 PR 标题中使用约定式提交
双语同步：始终同时更新两个 README 文件
测试技能：在提交 PR 前验证技能是否有效

Azure Data Explorer (Kusto) 查询技能：KQL数据分析、日志遥测与时间序列处理

125,100 周安装

添加新技能	在英文和中文 README 的技能表中添加
技能描述更改	更新技能表中的描述
技能移除	从技能表中移除
技能钩子更改	更新技能表中的自动触发列
仅内部技能逻辑	跳过 README 更新
不影响用户的错误修复	跳过 README 更新

自动创建PR与双语文档同步技能 - 代码提交与文档更新自动化

🇨🇳中文介绍

创建 PR

此技能何时激活

PR 创建工作流程

步骤 1：分析变更

步骤 2：确定文档更新

检查技能变更

决策矩阵

相关 Skills

自动触发变更需要更新

步骤 3：起草提交消息

步骤 4：创建拉取请求

步骤 5：更新文档（如果需要）

步骤 6：更新变更日志（可选）

文档更新指南

技能目录更新模板

自动触发列值

何时更新 README

双语更新格式

语言切换链接

PR 描述模板

常见场景

场景 1：添加新技能

场景 2：修改现有技能

场景 3：仅错误修复

验证清单

快速参考

提示

最新 Skills