AndroidのPR作成前のチェックリスト

PR作成の際に

PRを作成する際に最近自分が自分がやりがちなミスを列挙します。

深い設計や効率の良いコードは難しくとも単純ミスを減らすためにのチェックリストです。PR作成前の動作確認と、せめてこのチェックリストは見返すようにしています。

チェックリスト

• レイアウトファイルやManifestファイルはなるべく閉じタグをなくす

中に他のタグを挟む必要が無い場合は、として、コンパクトにタグを記述する。

• Log.dなどデバッグ用のコードの削除
• 日本語文字列やURLはリソースファイルを使って表記
• アップロードキーなど、コミットに含めるべきで無いファイルをGit管理に含めていないか？
• 変数名、メソッド名はUpperSnakeCaseで命名する
• レイアウトファイルのインデント幅は統一されているか？
• 変数やメソッドでprivate宣言に変更すべきところが残っていないか？
• プロジェクトでktlintフォーマッターを導入している場合は、フォーマットコマンド実行
• Androidに限らず、マージやリベース時のコンフリクト解消時のミス
• 各ファイルの右上のチェックマークがOKになっているか

このチェックマークがいつもエラーを検知してくれたり、知らなかったメソッドをサジェスションしてくれていることに気付けて助かっています。特にライブラリをアップデートした場合など、コードを変更する必要が出てくることが多いです。

PR作成後

PR作成後もすぐにレビュー依頼をするのではなく、PRのfile changedでPR中で変更したファイルを全て確認する。

PRに含める全ての変更が見れるので、最後の最後に誤りに気付けるかもしれません。自分の場合はここでレイアウトファイルのインデント崩れに気付けたりします。