| name | pr |
| description | ブランチ・Git運用ルール。feature ブランチ作成、コミット、プッシュ、PR作成の手順。品質チェック後のGit操作フロー。 |
| when_to_use | PR作成時、ブランチ作成時、「PR作って」「プルリク」「pushして」「PRお願い」などの発言時 |
ブランチ・Git 運用ルール
このスキルは「PRのベースブランチ」と「リポジトリのデフォルトブランチ」を区別する。
両者が一致するプロジェクト(ベース = デフォルト)と、一致しないプロジェクト(例: 統合ブランチにPRを積み、
デフォルトブランチは別)とで挙動が変わる点に注意する。以下では前者を「ベースブランチ」、後者を
「デフォルトブランチ」と呼ぶ。
ブランチ作成
- gh コマンドを使用すること
- 修正前に必ずベースブランチから feature ブランチを作成する
コミット〜PR作成(順序厳守)
品質チェック(format / lint / 動作確認)が完了していることを前提に、以下を実行する。
git status を確認し、差分が存在することを確認する
- すべての差分を含めてコミットする
- フォーマット・lint 修正による差分を含めること
- git の命名規則に従う
- プッシュする
- PR を作成する(into はベースブランチ)
完了条件
- 作業完了時点で
git status が clean であること
- コミット後に新たな差分を発生させ、そのまま放置しないこと
PR と Issue のクローズルール
- PR をクローズ(マージまたは Close)した場合、関連付けられている Issue も必ずクローズすること
- PR と Issue の紐付けは、PR 作成時に本文に
Closes #issue番号 を記載することで行う。
- PRのベースがデフォルトブランチでない場合、
Closes #N を書いても GitHub による自動クローズは働かない
(自動クローズはデフォルトブランチ向けPRでのみ機能する)。この場合、マージ後に明示的なクローズが必要。
- 通常のマージ経路では
/merge スキルがマージ後に PR 本文の Closes #N を抽出し gh issue close でクローズする。
- 手動で PR を Close した場合は、必ず関連 Issue も手動で Close すること
- Issue 番号の確認方法:
- PR 作成時に紐付けた Issue 番号を確認
gh pr view <PR番号> で関連 Issue を確認
実行コマンド例
gh pr merge <PR番号> --merge
gh issue close <Issue番号>
gh pr close <PR番号>
gh issue close <Issue番号>