LoginSignup
4
3

More than 3 years have passed since last update.

GitHubでプルリク、GitLabでマージリクエストを送る前のチェックリスト!

Posted at

マージリクエスト前にチェックするとよい内容

あくまで目安です。
全部をガチガチに確認することまではしなくて良いと思いますが
確認の抜け漏れがないか、参考にする程度に使ってください。

指差し確認、ヨシ!

ブランチ関連

  • マージ先のブランチが間違っていないか?
  • 自分のブランチ名がわかりやすいか?
    • (無理に修正しなくて良いが、次回以降気をつける)
  • マージ先、リモートのmasterブランチの変更が適宜取り込まれているか

内容確認

マージ先と差分を取り確認

  • 作業時の一時的なものがのこってないか

    • 個人的なメモの為の改行、コメントの消し忘れがないか
    • デバッグのためにしたコメントアウトが残っていないか
    • 不要なimport文がないか
    • 新しく一時的に作ったが使用していない変数、メソッド、処理など
    • 不要ファイル(個人用IDEの設定ファイル等)が含まれていないか
  • 自分の実装などの確認(ソースコード)

    • エディタでのチェックが働かないようなファイル(XML, md, 設定ファイル等)に誤字がないか
    • あやまって消してしまっている記述がないか
    • 分かりづらい処理がないか。わかりづらい箇所にはコメントが書いてあるか
    • テストが書かれているか (可能であれば)
    • 命名規則、記法(camelCase, SNAKE_CASE, Pascal...)が守られているか
    • フィールドを無意味にpublicにしていないか
    • コミットコメントが適切だったか
    • (無理に修正しなくて良いが、次回以降気をつける)

テストが通るか確認

単体テスト

  • 実装、変更箇所がEclipseからの単体テストで問題ないか

ビルドの確認

  • ビルドツール(gradle)からのテスト・ビルドが通るか
    • 通らない場合は、問題のある箇所を確認。環境依存などの問題がある。

動作の確認

  • ローカル環境で、実際に動作確認をしたか。
    • どのように確認したか

マージリクエストのコメント

  • チケットの番号、内容がわかるか
  • チケットに対して対応できているか(要求事項に過不足ないか)
  • 変更箇所がわかりやすいか。
  • 変更の意図がわかるか。
  • ローカルでテストできているか、動作確認しているか
4
3
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
4
3