SakuraWi - BLog

みんなのウェディングのエンジニア。聴いたお話をまとめておく倉庫的な。スタックストックスタック!

はじめてのプルリクエストを出してみよう講座


ども、Sakurawiです。

そういえば、プルリクエストって初めて出す時めちゃくちゃ怖くないですか?

そんなあなたにこれくらい書いておけばひとまず、おーけーでしょう!ということを書いておきます。

これだけは書いとけ!

プルリクエストを出す時は、これだけは書いておきましょう。

  • 目的
  • 内容

目的はなぜこのプルリクエストを出すのか。コードの変更する目的は何かを読み手に伝わるようにしておきましょう! もちろん、わかりやすいコードを書いて、それだけで伝わるのがベストですが、そんなに簡単にはいきませんよね。 レビュワーがさっとみて目的を把握してコードを読める状態を作れるといいかなと思います。

内容は、ざっくりどこをどう変更したのかを書きます。 メソッドを追加、テストを追加、などなど書くケースが多いです。

出しちゃえ、出しちゃえ

ぶっちゃけマージしなければ、下書き保存のようなものです。怖くないです。 出してみてから、レビューされて学ぶことも多いと思います。 まだWIP(途中)の状態からPRを出すな、という人もいますが、勉強中であれば、それでいいと思います。 レビューはまだでいいですよーという時は、タイトルに [WIP] などをいれておけばいいでしょう。

最初はビビリがちですが、恐れることはありません! やってみましょう。