タグ

ブックマーク / zenn.dev/ckona (1)

  • 心がけている PR の書き方とコードレビューについて

    私が普段心がけている PR の書き方やコードレビューの方法をご紹介しようと思います。 そもそもコードレビューってどうやるの、どういった観点でコードレビューをするのか、みたいなところは、わかりやすい記事がたくさんあるので、そちらを参照していだくと良いと思います。 この記事では、 PR の書き方やレビュアーにアサインされた際のコメントの仕方などをご紹介できればと思います。 1. PR を作成する Github に限定した PR の出し方を順を追って説明します。 下記の画像は PR を作成する際の例です。 ご参考までに。 (1) ブランチの設定をする 派生元のブランチと変更ブランチを正しく設定します。 (2) 説明を記入する フォーマットが決まっていればそれに従うようにします。 特に決まっていなければ、 Why , What を書くと良いと思います。 Why なぜこの PR が必要なのかを記載し

    心がけている PR の書き方とコードレビューについて
  • 1