/note/tech

書き手の意図やコードの背景を残す方法のあれこれ −きれいなコードの次に意識すべきこと−

  • はじめに
  • 大前提として
  • テストコードとセットでコードを書く
  • コミットの粒度に気を付ける(blameしやすいコミット粒度にする)
    • コミット粒度に関する参考文献
  • 開発チケットへのURLをコミットメッセージに残す
  • (必要であれば)コードにコメントを書く
  • 解説ドキュメントを書いてそのリンクを載せる
  • コード説明会を開いてその動画のリンクを載せる
  • 書き手の意図が伝わるきれいなコードを書く(reprise)
    • Q. コードの美しさなんて主観に過ぎないので意味がないのでは?
  • 番外編:なるべく退職者を出さない
  • 番外編その2:不要なコードやデータベースのテーブルやカラムは消す
  • まとめ
    • 自分の創意工夫をみんなで共有し合おう