コードを読む時に気をつけているポイントの自分用メモ。(Githubを使っていることを想定)
ディレクトリ構成を理解する
ディレクトリ構成とファイル名を理解することでどんなプログラムか読み取ることができる。
フレームワークを使用している場合は、公式リファレンスにディレクトリの説明が書いてあるのでそれを読んで、ディレクトリの役割を理解する。
テストを読む
テストを読むことでインプットとアウトプットを理解する。
テストの文言からどのような事をおこなうプログラムなのか理解する。
コードを読む
ざっと関数だけを眺める。細かい実装は必要になったときに読む。
commitメッセージを読む
git blameを実行することで行毎のcommitメッセージを読むことができる。
git logを実行することでcommitログを新しい日付順に表示できる(デフォルトの場合)。
commitログからどのような変更か理解する。(Howの理解)
プルリクエストを読む
プルリクエストからどういった意図でプログラムが実装されているか理解する。(Whyの理解)
