NO.290
DATE
Webフロントエンドのコードレビューメモ2
また、以下の記事の続きを書こうと思います。
ビジネスロジック
アプリケーションのビジネスロジックに関することについて書きます。
- 複数パラメータによる条件分岐がある場合、不都合なパターンが存在しないか
- 3つ4つと増えると、都合が悪いパターンが稀に発生するため
- アクセスして良い画面（認証）であるか、参照して良いデータ（認可）であるか
- 許可していないのにアクセスできたり、許可しているのにアクセスできなかったり
- 対象ドメインを適切に表す型であるか、嘘をついていないか
- 無駄な型だと、余計なガード処理を入れる必要がでる
- 嘘をついている場合、保守する際にバグを生む可能性がある
- 必要十分なデータのみ扱っているか（過剰ではないか）
- APIのデータフェッチや、オブジェクトへ保持されるデータなど
- 過去・現在・未来と考慮できているか
- 設計をそのまま未来へスライドしても不都合がないか
- 今は良いけど、近い未来に運用上困らないか。トイルは生まれないか。
- 現在の設計により過去の設計に不都合がないか
- データを整えたり、移行手順を用意できているか
- 設計をそのまま未来へスライドしても不都合がないか
- 登場人物のコンテキストに配慮できているか
- 誰が使うものか、どういう状況で使うものか
レビュー
レビュー時に考慮していることについて書きます。
- レビューコメントに、質問意図は添えれているか
- レビュイへの負担を減らせているか
- imo,ask,nits,must,fyi と色分けできているか
- 質問なのか共有なのか、読み方が変わるため
- 具体的なものを書いて、わかりやすくコメントできているか
- コードスニペットか、パッチを当てるPRを出すなど
- Storybook 等で、指摘したい箇所を画像・動画を残せているか
- 時間軸が大事であれば、タイムラインをリスト形式で書けているか
- 具体的なドメインデータ（登場人物名や商品名など）で会話できているか
- 何十行も長文ではなく、端的にコメントできているか
- 読む時間や読む負荷を下げれているか
- 良い点や学びがある点など、ポジティブなフィードバックを出せているか
- レビュイへの敬意を忘れていないか
- 提案頂いたことへ感謝すること
- レビュー中に確認したことについては、コメントを残せているか
- 動作確認の報告や、関係者へ確認したSlackリンクなど
終わりに
また思いつくことがあれば、書こうと思います！
-
※ ログイン不要で投稿できます。
※ 同じブラウザから投稿を削除できます。
0
読み込み中...
関連する記事
タグ「フロントエンド」の記事
Webフロントエンドのコードレビューメモ
Webフロントエンドのコードレビューをしているときに考えていることについて書きます。 毎日1記事投稿、1記事30分という制約を課していますので、本記事は完璧ではありません。(言い訳) また希望的な考えもあるので、実践していないものもあります
2026年03月12日
AIの書いたコードの手直しを減らすお作法
AI にコードを書かせた後、余計なコードを見つけて消す作業があります。 不毛なことなので、それらの作業を減らすためのお作法を紹介します。 未使用コードを消す 以下でも書きましたが、未使用コードの検査に knip を使うことが多いです。 ht
iframeの難しさ
最近、iframeを使っています。 クライアントサイドで埋め込む想定で、iframeを使おうとしています。 色々と苦労したことがあったので、書いて残しておこうと思います。 レスポンスヘッダー 前提として、ウェブアプリケーションをプロダクショ