プルリクエスト

プルリクエストについて。

4 minute read

プルリクエストの作成手順

mainブランチから作業ブランチを切ります。
ファイル修正をします。
作業が終了したらコミット & プッシュします。
プルリクエストのタイトルにはprefixをつけ、わかりやすい文にします。例: 「docs: チェックインについての記述を更新」
- 参考：Commit Message
Draft プルリクエストを作成して、コードの修正箇所を再度確認します。
確認を終えたらOpenにしてレビュー依頼を行います。

PRで変更した部分がわかるような証跡を残すことが重要です。

また、適切なサイズ調整（例えば、<img src="" width="50%">を使用）やテーブルでの整理することで、レビュワーに変更をわかりやすく伝えることができます。

コメントは、レビュワーがコードの意図を素早く理解し、効果的なフィードバックを提供するための基盤となります。

また、未来のメンテナンスを行う他の開発者にとっても、コードの理解を助け、意思決定の背景を明らかにするための貴重な情報源となります。

追加コミット等で差分が変更された場合は、プルリクエストの説明も必ず更新しましょう。

特に、そのプルリクエストでやったことや、やらないことの説明は最新の状態に保ちましょう。これにより、プロジェクトの進捗が最新化され、質疑の往復を防ぐことができます。

PRを提出したら、CI（GitHubでは「Checks」という）が成功しているを確認し、失敗していればPRをDraft状態にしてから調査・修正を行いましょう。

CIの成功は、コードの健全性と互換性を保証する重要なステップです。

問題を早期に発見し、修正することで、開発プロセスがスムーズに進行し、最終的な品質が向上します。

また、他のチームメンバーがレビューする前にすべてのテストがパスしていることを確認することで、レビューの効率も大幅に向上します。

コンフリクトがある場合は、これを解消してからレビュー依頼を出すようにしましょう。

コンフリクトを未解決のままレビュー依頼をすると、レビュワーが不必要な時間を費やすことになり、プロジェクトの進行に遅延をもたらす可能性があります。

手順は以下の通りです。

ローカルのmainブランチを最新化します。
1. git switch main
2. git pull origin main or git pull --rebase origin main
作業ブランチにmainをマージします。
1. git switch 作業ブランチ名
2. git merge main
3. コンフリクトが発生した場合、VS Code上で解消後、コミット&プッシュを行います。
  - 参考：Git Conflict Resolution

作業ブランチのブランチ名については下記を参照してください。