プルリクエストクリエイター

このスキルは、リポジトリの標準に準拠した高品質なプルリクエストの作成をガイドします。

ワークフロー

プルリクエストを作成するには、以下のステップに従います:

1. ブランチ管理: 重要: main ブランチで作業していないことを確認します。

   • git branch --show-current を実行します。
   • 現在のブランチが main である場合、新しい説明的なブランチを作成してスイッチする必須です:

     git checkout -b <new-branch-name>
     

2. 変更をコミット: すべての意図された変更がコミットされていることを確認します。

   • git status を実行してステージされていない、またはコミットされていない変更がないか確認します。
   • コミットされていない変更がある場合は、続行する前に説明的なメッセージとともにステージしてコミットします。決して main に直接コミットしないでください。

     git add .
     git commit -m "type(scope): description"
     

3. テンプレートを検索: リポジトリ内のプルリクエストテンプレートを探します。

   • .github/pull_request_template.md をチェック
   • .github/PULL_REQUEST_TEMPLATE.md をチェック
   • 複数のテンプレートが存在する場合 (例: .github/PULL_REQUEST_TEMPLATE/ 内)、ユーザーに使用するテンプレートを尋ねるか、コンテキストに基づいて最も適切なものを選択します (例: bug_fix.md vs feature.md)。

4. テンプレートを読む: 特定されたテンプレートファイルの内容を読みます。

5. 説明を作成: テンプレートの構造に厳密に従う PR 説明を作成します。

   • 見出し: テンプレートからすべての見出しを保持します。
   • チェックリスト: 各項目を確認します。完了した場合は [x] でマークします。項目が適用不可能な場合は、チェックなしのままにするか、[ ] でマークします (テンプレートの指示による)、またはテンプレートが柔軟性を許可している場合は削除します (ただし、透明性のためチェックなしのままにすることをお勧めします)。
   • コンテンツ: 変更の明確で簡潔な要約でセクションを入力します。
   • 関連イシュー: このPRで修正または関連するイシューをリンクします (例: "Fixes #123")。

6. プリフライトチェック: PR を作成する前に、ワークスペースのプリフライトスクリプトを実行して、すべてのビルド、リント、およびテストチェックが成功することを確認します。

   npm run preflight
   

   チェックが失敗した場合は、PR 作成に進む前に問題に対処してください。

7. ブランチをプッシュ: 現在のブランチをリモートリポジトリにプッシュします。 重要な安全柵: プッシュする前にブランチ名を二重確認してください。 現在のブランチが main の場合は決してプッシュしないでください。

   # 現在のブランチが main ではないことを確認
   git branch --show-current
   # 非対話的にプッシュ
   git push -u origin HEAD
   

8. PR を作成: gh CLI を使用して PR を作成します。複数行の Markdown でのシェルエスケープ問題を避けるため、まず説明を一時ファイルに書き込みます。

   # 1. 作成された説明を一時ファイルに書き込む
   # 2. --body-file フラグを使用して PR を作成
   gh pr create --title "type(scope): succinct description" --body-file <temp_file_path>
   # 3. 一時ファイルを削除
   rm <temp_file_path>
   

   • タイトル: リポジトリが使用している場合、タイトルが Conventional Commits 形式に従うことを確認します (例: feat(ui): add new button、fix(core): resolve crash)。

原則

• 安全第一: 決して main にプッシュしないでください。これはあなたの最優先事項です。
• 準拠: PR テンプレートを無視しないでください。それは理由があって存在します。
• 完全性: すべての関連セクションを記入してください。
• 正確性: 完了していないタスクのボックスにチェックを入れないでください。