【現役エンジニアが推奨】コミット前に確認することリスト！【Git】

みなさんこんにちは、現役エンジニアのサメハックです

未経験からWebエンジニアに転職し、
正社員として5年働いたのちフリーランスとして独立しました。

今回はコミット前に確認することについて学んでいきましょう！

駆け出しエンジニアや未経験の方、
また新入社員を指導する先輩社員にとっても
わかりやすいように解説していきます！

コミット前に確認すべきこと

ブレークポイントが残っていないか

残りがちなゴミ処理TOPとしてdebuggerの削除漏れがあります。

console.logが残っていないか

debugger同様コードレビューの際によく見ます。
処理に影響がないので削除漏れが発生しやすいです。

未使用の変数・関数が残っていないか

未使用のインポート処理が残っていないか

AngularやNode.jsを使用しているとよく見かけます。

不要なコメントが残っていないか

関数等の説明コメントが間違っていないか

JSDocなどで説明コメントを付けているものの
そのコメント内容が間違っている(更新が漏れている)ものもよく見かけます。

過去の処理をコメントアウトして残していないか

const myFunc = () => {
  // console.log("過去の処理");
  console.log("新規処理");
}

このように過去の処理をコメントアウトして残している人を
たまに見かけますが、これはNGです。

これを繰り返すとコードがグチャグチャになってしまいます。

たとえば、どちらの処理を行うか検討中で
クライアントに動かしてもらってから正式リリースする
などのよっぽどの理由がない限りは削除しましょう。

関数宣言の記述順が適切か

の順で処理を行う場合には、関数宣言も同じ順で記述しておくべきです。
処理には影響はありませんが可読性に大きく影響します。

ライフサイクル順に処理が記述されているか

例えばAngularの場合にはこのようなライフサイクルがあるので
宣言文も同じ順で行いましょう。

Angularの記述ルール:参考程度

参考程度ですが、以下のような順での記述ルールをよく見かけます。

購読の解除処理が入っているか※Angular

subscribe()で購読したObservableは
必ずngOnDestroyでunsucscribe()する必要があります。

【Angular】unsubscribeの重要性【RxJS】

samehack.com

データ型がanyのままになっていないか※主にTypeScript

実装時にはanyとしていることが多いかと思いますが、
正式版をリリースする前には極力正しいデータ型を指定するようにしてください。

diffの確認

git diff

で前回コミットとの差分が確認できます。
ここで無駄な処理が入っていないかなどを確認しましょう。

コミット後にミスに気づいたときの対応

コミットの取り消し

git reset --soft HEAD^

コミット後にミスに気づいたときには
このコマンドでコミットの取り下げができます。

まとめ

満足いただけたら、1クリックなのでSNSフォローしてもらえると嬉しいです🦈

twitter
instagram