Android開発のマージリクエストで最低限確認するべき項目まとめ

このドキュメントについて

本ドキュメントはAndroid開発において最低限確認するべき項目をまとめたものです。

作成理由

マージリクエスト時のレビューは基本的にはレビューアの技術力に左右されるものだと思いますが、 よく忙しさやモチベーションに比例して指摘できる事項が異なってきたりしてしまいます。

そのため毎回必ず確認すべき項目についてチェックリストを作成することにしました。

コードレビューでチェックする観点は多数存在するのですが、 あまりにチェック項目が多すぎるとレビューコストが高くなり、おざなりになりがちです。 そのため今回は必ずチェックすべき項目のみピックアップしたつもりです。

レビュー項目

• 設計確認

  • [ ] 設計（要件）を満たすように実装されていること
  • [ ] 設計や要件に記載がない箇所についてはTODOが残されていること

• UI

  • [ ] 各解像度でレイアウトが確認されていること(スクショが上がってなかったら貼ってもらう)

• コーディング

  • [ ] 重複したコードが存在しないこと
  • [ ] クラスの責務が明確になっていること(メソッドが存在するクラスは適切に選択されていること)
  • [ ] メソッド名から想定できない処理をメソッド内で実施していないこと
  • [ ] 一目でわからない処理をする場合は"目的(理由)"や"思想"についてのコメントが書かれていること
  • [ ] 不要なコード/リソースが残っていないこと

• 命名

  • [ ] クラス名・変数名・定数名・メソッド名が適切に命名されていること