Stack Map新人 Web エンジニアの地図

コードレビューは、マージの前に、ほかの人の目でコードを確かめることです。
まず下の練習で、わざと問題を入れた PR を読んでみてください。考え方のヒント の印は、出典のない考え方や、練習のための作り物です。

練習: 問題を見つける 考え方のヒント

打刻の修正申請を「承認」できるようにする PR です。わざと 9 つの問題を入れました。怪しいと思う行を押してください。視点を変えて読むと、見つかる問題が増えます。

見つけた問題

見る順番

Google のレビューの指針は、3 つの段階で見る、としています。「この PR なら」は、上の練習に当てはめた例です。

    何を見るか

    コメントの書き方

    人ではなく、コードのことを書きます。なぜ問題なのかを添えると、作った人が次から自分で気づけます。

    言い方の ✕ と ○ 考え方のヒント

    印を付ける

    コメントの頭に印を付けると、「必ず直してほしい」のか「できれば」なのかが伝わります。印を選ぶと、例のコメントが変わります。

    コメントの道具

    レビューを受ける側

    指摘は、コードをよくするための材料です。出す前の準備と、受け取り方のコツです。

    AI 時代AI のレビュー

    AI がレビューを手伝う道具が増えました。速く広く見てくれる一方で、見落としも間違いもあります。最後に確かめるのは人です。

    チェックリスト

    PR を出す前と、レビューするときに。確かめたものにチェックを付けてください(この端末にだけ保存されます)。考え方のヒント