読み方のヒント

矢印ボタン(または ← → キー)でページを移動できます。

第4節 チームの決まりをまとめる

4.2 決まりを見直す

決まりは、使いながら見直します。

見直すきっかけすること
同じ意見がレビューで3回出た観点の一覧か、ESLint の決まりに足す
決まりを守るのが手間で、外す例外が増えた決まりそのものを見直す
新しい版の道具が出た設定と文書を、新しい版に合わせる
新しい人が迷った迷った場所を、文書の「迷ったとき」に足す

決まりを変えるときも、プルリクエストで変えます。文書の変更も、コードの変更と同じように、ほかの人に読んでもらってから入れます。

記入例

「.env.example がなく、どの環境変数が要るか分からなかった」「Playwright のブラウザを入れる手順が書かれていなかった」のように書き出し、README.md を直します。手順は、新しく加わった人に、実際に試してもらうと、抜けが見つかりやすくなります。

解答の例

docs/review.md のアクセシビリティの観点に、「押す部品は <button>(または共通の Button)で作る」を足します。あわせて、ESLint のアクセシビリティの決まり(jsx-a11y の click-events-have-key-events など)が有効になっているかを確かめ、機械で見つけられるようにします。

16 / 17