prowler-pr について
prowler-prは、Prowlerのプルリクエスト作成と管理を支援するスキルです。変更分析、テンプレート記入、コンポーネント別チェック、レビュー対応の手順を示します。
主な機能
- 01ブランチのコミットと変更の分析
- 02コンポーネント別の変更ログと確認項目
- 03Conventional Commits形式のタイトル
- 04PRテンプレートと作成コマンド
- 05再レビュー依頼前のスレッド整理
活用シーン
- 01ブランチの変更をPRにまとめる
- 02コンポーネント別の貢献要件を確認する
- 03再レビュー依頼前にレビューコメントへ対応する
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ prowler-cloud/ prowler --skill prowler-prインストール後、Claude Code で/prowler-prを入力して読み込まれたか確認します。
同梱ファイルreferences/pr-docs.md
詳細
PR 作成プロセス
- 変更を分析する:
git diff main...HEADですべてのコミットを確認します - 影響を受けるコンポーネントを特定する:SDK、API、UI、MCP、ドキュメント
- 変更内容に基づいてテンプレートの各セクションを記入します
gh pr createで PR を作成します
PR テンプレートの構成
### Context
{Why this change? Link issues with `Fix #XXXX`}
### Description
{Summary of changes and dependencies}
### Steps to review
{How to test/verify the changes}
### Checklist
<details>
<summary><b>Community Checklist</b></summary>
- [ ] This feature/issue is listed in [here](https://github.com/prowler-cloud/prowler/issues?q=sort%3Aupdated-desc+is%3Aissue+is%3Aopen) or roadmap.prowler.com
- [ ] Is it assigned to me, if not, request it via the issue/feature in [here](https://github.com/prowler-cloud/prowler/issues?q=sort%3Aupdated-desc+is%3Aissue+is%3Aopen) or [Prowler Community Slack](goto.prowler.com/slack)
</details>
- Are there new checks included in this PR? Yes / No
- If so, do we need to update permissions for the provider?
- [ ] Review if the code is being covered by tests.
- [ ] Review if code is being documented following https://github.com/google/styleguide/blob/gh-pages/pyguide.md#38-comments-and-docstrings
- [ ] Review if backport is needed.
- [ ] Review if is needed to change the Readme.md
- [ ] Ensure a changelog fragment is added under <component>/changelog.d/, if applicable.
#### SDK/CLI
- Are there new checks included in this PR? Yes / No
- If so, do we need to update permissions for the provider? Please review this carefully.
#### UI (if applicable)
- [ ] All issue/task requirements work as expected on the UI
- [ ] Screenshots/Video - Mobile (X < 640px)
- [ ] Screenshots/Video - Tablet (640px > X < 1024px)
- [ ] Screenshots/Video - Desktop (X > 1024px)
- [ ] Ensure a changelog fragment is added under ui/changelog.d/
#### API (if applicable)
- [ ] All issue/task requirements work as expected on the API
- [ ] Endpoint response output (if applicable)
- [ ] EXPLAIN ANALYZE output for new/modified queries or indexes (if applicable)
- [ ] Performance test results (if applicable)
- [ ] Any other relevant evidence of the implementation (if applicable)
- [ ] Verify if API specs need to be regenerated.
- [ ] Check if version updates are required.
- [ ] Ensure a changelog fragment is added under api/changelog.d/
### License
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
コンポーネント固有のルール
| コンポーネント | 変更履歴フラグメント | 追加チェック |
|---|---|---|
| SDK | prowler/changelog.d/ | 新しいチェック → 権限の更新が必要ですか? |
| API | api/changelog.d/ | API 仕様、バージョン更新、エンドポイントの出力、EXPLAIN ANALYZE、パフォーマンス |
| UI | ui/changelog.d/ | モバイル/タブレット/デスクトップのスクリーンショット |
| MCP | mcp_server/changelog.d/ | 該当なし |
コマンド
# Check current branch status
git status
git log main..HEAD --oneline
# View full diff
git diff main...HEAD
# Create PR with heredoc for body
gh pr create --title "feat: description" --body "$(cat <<'EOF'
### Context
...
EOF
)"
# Create draft PR
gh pr create --draft --title "feat: description"
タイトルの規則
Conventional Commits に従います:
feat:新機能fix:バグ修正docs:ドキュメントchore:メンテナンスrefactor:コード構成の変更test:テスト
PR 作成前
- ✅ すべてのテストがローカルで成功している
- ✅ リンティングが成功している(
make lintまたはコンポーネント固有のコマンド) - ✅ 変更履歴フラグメントが追加されている(該当する場合)
- ✅ ブランチが main の最新状態に追従している
- ✅ コミットが整理され、内容がわかりやすい
レビューを再依頼する前(必須)
レビューを再依頼する前に、未解決のインラインレビュー スレッドすべてに対応するか、返信してください:
- 同意して修正した:変更をコミットします。レビュー担当者がすぐに確認できるよう、コミットハッシュを返信します:
abc1234で修正しました。 - 同意したが先送りした:この PR の範囲外である理由と、追跡先を説明します。
- 同意しない:明確な技術的根拠を返信します。スレッドを返信せずに放置しないでください。
- すべてのスレッドが解決済み、または明示的に返信済みとなり、整理された状態になってからのみ、レビューを再依頼します。
目安:レビュー担当者が PR を再確認したときに、「コメントを確認したのだろうか」と疑問に思うことがないようにしてください。
リソース
- ドキュメント:ローカルの開発者ガイドへのリンクは references/ を参照してください
コメント
Markdown 対応