新卒エンジニア
新卒
新卒応援

既存案件にJoinする場合の注意点

More than 1 year has passed since last update.

概要

既存案件に入る時、または改修案件に関わる時にどうしたら良いのかわからなかったことが多数あったため、その時に先輩方に教えてもらった知見をまとめる。プログラムはある程度読めることを前提として書くのでご了承を。また、これより良い方法や別の方法がある場合はコメントくださると嬉しいです。

ソースコードを読む

よく言われることではあるけれどもその際にこのようにして読むと理解が捗るとのこと。

プルリクエストをひたすら追う

プルリクエストには

どのように修正したら良いのかなどの知見が詰まっている

なぜそのように修正したのかのメッセージが残っていたり、issueと絡めているとこ
ろはどのような問題を元に改修したのかがわかる。

追っていると、プロジェクトの方針、dryの考え方に反した改修を避けることができる。

クラス、メソッドの仕様を把握する

改修を頼まれた箇所に関係するクラス、メソッドを必ず把握しきる。
ここをおろそかにして返り値などをあまり把握しないまま使うとシステムの理解が進まず、
数年経っても技術力やシステム理解が進まない。

システムを使い込む

ソースコード云々以前に使わないとユーザがどう感じるかわからないよねというお話。

使いにくいところがないかを確認する

ユーザビリティ的な観点から問題はないのかを確認する。
JoinしたばかりだからこそすでにJoinして長い時間が経っているメンバーにはわからないところにも気づける。
また、理解が進むことでソースコードが読みやすくなるといった助けもある。

※2017/11/02 追記

まとめ

要するに当たり前のことをやれということ。