レビュー時に行っていることを振り返ってみました。
1. プルリクの diff を眺めてコードレビュー
文章としての違和感を確認
段落のズレや不要なスペースが入っていないか、書き方が統一されているかをチェックします。
リンターやフォーマッターは非常に優秀ですが、完全に網羅できない部分もあります。そのため、私は diff を眺めながら違和感に気づくことが多いです。
リファクタリングの可能性を探る
diff ではファイルを跨いでコードの変更点を一望できるため、リファクタリングできそうな箇所を見つけやすいです。
気になった部分はローカルで実際に試してみます。
2. ローカルでのスペルチェック
人は間違うのもなので、スペルチェックはエディタに任せています。
私は Vim を使用しているので、以下のプラグインを活用しています
3. 仕様の確認
元々の仕様やプルリクでの変更内容をしっかり確認します。
正常系・異常系の判断をするには、まず仕様を正しく理解することが必要です。また、仕様そのものに違和感や見落としがないか、多角的にチェックすることも大事だと考えています。
4. 正常系の動作確認
とりあえず「想定通り動くか」を確認します。
実装中に一度は動作確認していても、その後の微調整で意図せず動作が変わってしまうことがあります。だが、そのことを実装者自身が気づていないケースもあります。
5. 異常系の動作確認
異常系の想定漏れがないかをチェックします。
具体的には、以下のようなケースを試します：
- ブラウザバックやボタン連打
- URL直打ち
- 非表示にすべき情報が見えていないか
「意地悪な操作をした場合どうなるか」を意識して確認するのがポイントです。
最後に
書き出してみたところ、思ったより項目が少なく、記事としては少し物足りないと感じました。
そこで、気分転換に一曲どうぞ。
「レビューの流れ」
この曲は、先日 ossan.fm で紹介されていた suno.ai を使って作りました。適当にテキストを入れただけで、簡単に完成したのには驚きました！
個人的にお気に入りの歌詞
正常 非常のチェックを跨いで
コードの未来 闘志込めて描くんだ
レビューの苦労も 一瞬の喜び
君と分かち合う チームの栄光
最後までお読みいただき、ありがとうございました！