この記事を書こうと思ったきっかけ
最近gitを使ったチーム開発し始めたが、あまりにも凡ミス、初歩的なミスをしまくり先輩エンジニアにこってり叱られたので、自分でpushする前のチェック項目を作成すればミスる可能性が減ると思って書きました
対象読者
gitを最近触り始まて、怯えながらgit pushしているエンジニアに向けてます
チェック項目
大前提
- コードのコメントアウトの内容が適切であるか
- 変数名、関数名、クラス名はネーミング定義にそっているか。特になければ'言語 ネーミングルール`などでググっていい感じのルールを探す。Pythonならpep8などを参考にする。
- Pythonに限るがドックストリングの内容は簡潔に記載されているか。書き方など特に指定なければこちらの記事を参考に記載する。
- 不要なコードはないか。例えば確認用に記載したprintやTODOのコメントなど
- 修正内容がきちんと修正されているか。（プルリクで却下された内容に対応した修正となっているかなど）
git addする前
-
git statusで追加したいファイルが赤文字になっているか確認する。 - 余計なファイルがないか確認する。ある場合は追加したい対象のファイルのみをaddする
git add後
-
git statusで追加したファイルが緑文字になっているか確認する。 - 余計なファイルがないか確認する。ある場合はgit addの取り消しを行う。取り消し方法はこちら参照
問題がなければコミットを行う。
git commit -m '修正内容'
git commit後
-
git statusで追加したファイルが表示されていないことを確認する。 -
git logで的外れなコメントをしていないか確認する - 問題がなければ'git pull origin master'を行う。
問題がなければ'git pull origin master'を行う。（超重要！！）
git push後
- BacklogやGitBabやGitHub等で自分の追加・修正箇所が反映されていることを確認する。
その他
この項目も確認した方がよいなどあればコメントいただけると助かります！