🛤️
Rails プロジェクトでドキュメントを書く前に bin/setup をメンテすべし
bin/setup とは？
rails new すると bin/setup スクリプトも生成される。これは Rails が用意してくれている開発環境セットアップ用のスクリプトで、Railsガイドには「アプリケーションの初期設定時に設定を自動化するためのコードの置き場所」と書いてある。
具体的には？
スクリプトはあくまで雛型で開発者が必要に応じてカスタマイズしていく想定になっている。
たとえば、
- brew で特定バージョンのパッケージを準備する
- bundle install
- npm install
- database.yml は別のファイルから生成する
- 仮データを準備する
などを行う。
ないがしろにされているプロジェクトが多い
自分の経験だけでいえば、後から参加したプロジェクトで bin/setup がメンテされているものが皆無だった。一方で、腐ったドキュメントや Wiki はたくさんあった。
なぜこんなことになっているのだろうか？ おそらく bin/setup は昔の Rails では無かったファイルなので存在を知られていないか、bin の下のものは編集してはいけないものと誤解されていると考えられる。
お願い
あとから開発に加わるメンバーや未来の自分への思いやりの気持ちをもって誰の環境でも bin/setup を実行するだけで環境が整うようにしてほしい。
Discussion