私が実践している分かりやすいプルリクの書き方

ホノルル空港の待合室なう🏝

休暇中ですが週一ブログ更新チャレンジは継続してます、岸です。

私は入江開発室ポートフォリオプロジェクトで初めてGithubを使って複数人での開発を経験したのですが、今回はその際に学んだ「分かりやすいプルリクの書き方」についてまとめます。

※入江開発室ポートフォリオプロジェクトについての記事はこちら。

プルリクとは？

プルリク（プルリクエスト）とは、開発者のローカルリポジトリでの変更を他の開発者に通知するGithubの機能です。 そもそもGitとは？については、こちらを参照下さい。

木村さんもGitについては分かりやすくまとめて下さってましたのでぜひこちらも。（チーム開発編も期待しております！）

分かりやすいプルリクとは

分かりやすいプルリクとは、「どんな開発をしたのかを一目で分かるもの」です。そのために私は、以下の内容をプルリクエスト内に記述しています。

・issueの概要
・開発したこと
・開発しなかったこと

適当に文章を書くのでなく、きちんと見出しをつけ箇条書きなどで見やすくしてあげると尚親切ですね。 

開発内容をスクショやアニメーションgifで解説

加え、フロントエンドの開発をした際は開発内容を文字だけでなく、画面キャプチャや動画でも補足するようにしています。こうすることで開発内容がより分かりやすく伝わりますね！

私が使っているツールを紹介しておきます。

・Skitch（画面キャプチャツール）
Evernoteが提供する画面キャプチャツールです。macOSのみ対応なのですが、下記のQiitaにある通り画面キャプチャを取る作業効率が爆上げしました。

Skitch | Evernote

macOSで画面キャプチャ効率を爆上げするSkitchを使おう - Qiita

・Screencastify（動画キャプチャツール）
Chromeアドオンの動画キャプチャツールです。有料版もありますが、今のところ無料版で全然事足りてます。 

Screencastify

最後に

プルリクにしてもブログにしてもプレゼンにしても、読み手/聞き手がどのような人物で、その人がどんなものを望んでいるのかをしっかり理解し分かりやすく簡潔に伝えることが大事ってことですね！