UIT INSIDE UIT INSIDE
2020/07/17 に公開 1632 views

このエピソードについて

@spring_raining が @potato4d @jaycompsci @T28_tatsuyaに、現在 UIT で策定中のコーディングスタイルについて聞いてみました。

自己紹介

  • @jaytype
    • UIT フロントエンドエンジニア
    • LINE NEWS のフロントエンド開発を担当
  • @T28_tatsuya
    • UIT フロントエンドエンジニア
    • LINE Survey, ショップカードを担当

UIT Playbookについて

  • プロジェクトの概要
  • コーディングガイドラインを決めるまでの背景
    • 元々コーディングガイドラインがあったが、長年メンテされておらず最近はほとんど守られていない状態だった

UIT Playbookが定めるコーディングスタイル

  • UIT Playbookはまだ始まったばかりだが、ルールの策定や整備はどのような手順で進めているか？
    • 基本はGitHubのPull Requestベース
    • 議論の過程で決まっていくことも
  • 最初に決めたことはネーミングルール
    • Boolean型を返すものは isXXX ？
  • Playbook という名前について

コーディングルールを決めることについて

  • どうしてコーディングスタイルを決めるのか？
    • 複数人が前提知識を共有して開発することができるもの
    • そのコードが恣意的なものか、そうでないかがひと目で分かる
    • 1つのコーディングスタイルを導入するのであれば、そのルールが守られ続けていることが大切
  • 1つのコーディングスタイルを守るか、複数のコーディングスタイルを用意するか
  • ESLint/Prettierの存在
    • ESLintには、あるルールに対して理由が添えられている

PR

Refs