GitHub Dasktop~プルリクエスト の作成~
続いてプルリクエストの作成を行います。
プルリクエスト とは?
ブランチでのコミット履歴を残すと共に、各コミットにおける変更修正にコメントをつけることができる GitHub の機能のことを言います。以下の図のような形で、1つのブランチでの作業について、コミュニケーションが取れる掲示板のようなものがプルリクエストです。
現在、作成中のリポジトリを例にしています
赤丸の部分は自身のリポジトリの状況で変化する事がありますが、流れは一緒です
"Create Pull Request"でHItHubの画面へ以降します
赤丸でプルリクエスト の作成、青枠部分は下記にて説明します
- [WIP]
個人開発ではつけませんが、チーム開発などでは[WIP]を付けるようにします。
WIP とは、Work In Progress の略で作業中の意味です。作業が終わっている場合には WIP を外します。「実装途中の機能には WIP をつける」「実装が一旦完了したプルリクエストからは WIP を外す」と考えてください。
- #what,#why
WhatとWhyを書くことで、このブランチは何を実装していて、なぜその実装を行ったのかが他の人に伝えることができます。What をしっかり書くことで、他者にコードを見てもらう際に、スムーズな理解を促すことができます。アプリケーションの機能が複雑になればなるほど、コードを読んだだけでは、何をしているのか把握することは難しくなるからです。また、Why をしっかり書くことで、本来の目的に沿ったコミュニケーションが可能です。実装目的が伝わっていないと、欲しい意見をもらうことはできません。
次回、プルリクエスト後に行う”マージ”について書いていきます。