create-pr について
create-prは、プルリクエストの準備を支援するエージェントスキルで、英語と中国語のドキュメントの整合性も確認します。ブランチの変更を調べ、コミットやPR作成を案内し、プロジェクト文書の更新要否を判断します。
主な機能
- 01ブランチの変更を確認
- 02二言語ドキュメントへの影響を確認
- 03コミットメッセージの作成を案内
- 04ステージング、プッシュ、PR作成
- 05PRの確認チェックリストを提示
活用シーン
- 01機能ブランチをレビュー用に準備
- 02スキルカタログの文書を更新
- 03変更に伴うREADME更新の要否を確認
インストール
コマンドをコピーしてターミナルで実行します。
npx skills add https:/ / github.com/ zhaono1/ agent-playbook --skill create-prインストール後、Claude Code で/create-prを入力して読み込まれたか確認します。
同梱ファイルREADME.md
詳細
PR の作成
バイリンガルのドキュメントチェックを行いながらプルリクエストを作成するスキルです。このスキルにより、コード変更を提出する前に英語と中国語のドキュメントの内容が一致していることを確認します。
このスキルが有効になるタイミング
次の場合に、このスキルが有効になります。
- プルリクエストまたは PR の作成を依頼したとき
- 「変更を送信して」や「プッシュして PR を作成して」と伝えたとき
- 「PR を作成して」や「プルリクエストを開いて」と伝えたとき
- コードをレビューに提出したいとき
PR の作成ワークフロー
ステップ 1:変更を分析する
現在のブランチにあるすべての変更を確認します。
git status
git diff
git log --oneline main..HEAD
次の項目を特定します。
- 変更されたファイル:何が変更されましたか?
- 新しいファイル:何が追加されましたか?
- 削除されたファイル:何が削除されましたか?
- 影響範囲:どのスキルや機能が影響を受けますか?
ステップ 2:ドキュメントの更新が必要か判断する
スキルの変更を確認する
まず、スキルが変更されたかどうかを確認します。
# Check if skills/ directory has changes
git diff --name-only main..HEAD | grep "^skills/"
判断マトリクス
| 変更の種類 | ドキュメントの対応 |
|---|---|
| 新しいスキルを追加 | EN と CN の両方の README のスキル一覧に追加 |
| スキルの説明を変更 | スキル一覧の説明を更新 |
| スキルを削除 | スキル一覧から削除 |
| スキルのフックを変更 | スキル一覧の自動トリガー列を更新 |
| スキルの内部ロジックのみを変更 | README の更新を省略 |
| ユーザーへの影響がないバグ修正 | README の更新を省略 |
自動トリガーの変更時は更新が必要です
スキルの metadata.hooks フロントマターを変更した場合は、スキルカタログの自動トリガー列を更新する必要があります。
# Check if hooks were modified
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. Stage only the intended files
git add <changed-files>
git commit -m "commit message"
# 2. Push to remote
git push -u origin <branch-name>
# 3: Create PR using gh CLI
gh pr create \
--title "PR title" \
--body "PR description"
ステップ 5:ドキュメントを更新する(必要な場合)
変更がユーザー向けのスキルカタログ、インストール、またはワークフローの動作に影響する場合は、コミットまたは PR の作成前に両方の README ファイルを更新します。
README.md(英語):
- 新しいスキルを適切なカテゴリの表に追加する
- 必要に応じてプロジェクト構成を更新する
- 最上部の言語切り替えリンクを維持する
README.zh-CN.md(中国語):
- 英語の変更をすべて反映する
- スキルの説明を翻訳する
- 同じ構成と書式を維持する
ステップ 6:変更履歴を更新する(任意)
重要な変更については、CHANGELOG.md に追加します。
## [Version] - YYYY-MM-DD
### Added
- New skill: skill-name
### Fixed
- Fixed issue in skill-name
### Changed
- Updated skill-name with new features
ドキュメント更新のガイドライン
スキルカタログの更新テンプレート
スキルを追加または変更する場合は、スキルカタログに次の形式を使用します。
英語(README.md):
### Category Name
| Skill | Description | Follow-up |
|-------|-------------|--------------|
| **[skill-name](./skills/skill-name/)** | Brief description | 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 を更新するタイミング
必ず更新する場合:
- 新しいスキルを追加するとき
- スキルを削除するとき
- スキル名や説明を変更するとき
- スキルディレクトリの構成を変更するとき
更新を検討する場合:
- 既存のスキルに重要な機能を追加するとき
- インストール手順を変更するとき
- プロジェクト構成を変更するとき
更新を省略する場合:
- ユーザーへの影響がない内部コードのリファクタリング
- 軽微な誤字の修正
- テストファイルの変更
バイリンガル更新の形式
スキルの表に新しいスキルを追加する場合:
英語(README.md):
| **[skill-name](./skills/skill-name/)** | Brief skill description |
中国語(README.zh-CN.md):
| **[skill-name](./skills/skill-name/)** | 技能简短描述 |
言語切り替えリンク
両方の README ファイルの最上部に言語切り替えリンクを置く必要があります。
README.md:
English | [简体中文](./README.zh-CN.md)
README.zh-CN.md:
[English](./README.md) | 简体中文
PR の説明テンプレート
PR を作成するときは、次のテンプレートを使用します。
## Summary
<Brief description of what this PR does>
## Changes
- [ ] New skill added
- [ ] Existing skill modified
- [ ] Documentation updated
- [ ] Tests added/updated
## Skills Affected
- `skill-name`: Description of change
## Documentation
- [x] README.md updated
- [x] README.zh-CN.md updated
- [ ] CHANGELOG.md updated (if applicable)
## Test Plan
- [ ] Skill tested in Claude Code
- [ ] Documentation links verified
- [ ] Bilingual translations checked
よくあるシナリオ
シナリオ 1:新しいスキルを追加する
# 1. Create skill files
mkdir -p skills/new-skill
touch skills/new-skill/SKILL.md
touch skills/new-skill/README.md
# 2. Install or link through the package CLI when possible
apb skills add ./skills/new-skill --scope project --target all --link
# 3. Update README.md (add to skills table)
# 4. Update README.zh-CN.md (add to skills table with translation)
# 5. Commit and push
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. Create PR
gh pr create --title "feat: add new-skill" --body "..."
シナリオ 2:既存のスキルの変更
# 1. Make changes to skill
vim skills/existing-skill/SKILL.md
# 2. Check if description changed
git diff skills/existing-skill/SKILL.md
# 3. If description changed, update README files
# 4. Commit, push, create PR
シナリオ 3:バグ修正のみ
# 1. Fix the bug
vim skills/some-skill/SKILL.md
# 2. Commit and push (no README update needed)
git add skills/some-skill/SKILL.md
git commit -m "fix: correct typo in some-skill"
git push
# 3. Create PR
gh pr create --title "fix: correct typo in some-skill"
検証チェックリスト
PR を作成する前に、次の項目を確認してください。
- すべての変更がコミットされている
- ブランチがリモートにプッシュされている
- コミットメッセージが Conventional Commits に従っている
- 必要に応じて README.md が更新されている
- 必要に応じて README.zh-CN.md が更新されている
- 両方の README に言語切り替えリンクがある
- 新しいスキルのシンボリックリンクが作成されている
- PR のタイトルが明確で説明的である
- PR の説明に概要と変更内容が含まれている
クイックリファレンス
| コマンド | 目的 |
|---|---|
git status | 現在の状態を確認する |
git diff | ステージされていない変更を確認する |
git log main..HEAD | ブランチのコミットを確認する |
git add <changed-files> | 対象のファイルのみをステージする |
git commit -m "msg" | メッセージを付けてコミットする |
git push -u origin branch | リモートにプッシュする |
gh pr create | プルリクエストを作成する |
ヒント
- まずコミットし、その後 PR を作成する:PR を作成する前に、必ず変更をコミットしてください
- 小さな PR:PR の対象を 1 つの変更に絞ってください
- 明確なタイトル:PR のタイトルには Conventional Commits を使用してください
- 二言語の同期:両方の README ファイルを必ず一緒に更新してください
- スキルをテストする:PR を提出する前に、スキルが動作することを確認してください