Git~README.md~
今日GitのMTGに参加したので、付随した話でREADME.md(リード・ミー)について書いていきたいと思います。
README.md(リード・ミー)とは?
リードミー(Readme)とは、ソフトウェアを配布する際の添付文書のひとつ。配布物の一般的な情報を記載したファイルである。多くの場合、そのソフトウェアをインストールし使用する前に読むべきものとされている。とWikipediaには記載されています。
Webアプリケーションを作る際、アソシエーション(MVCのモデル)を繋げるための設計図のようなものです。
Column | Type | Options |
---|---|---|
カラム名 | 単位(数) | 制約(外部制約)など |
user、itemなど |
integer、stringなど |
null:false、foreign_key:trueなど |
Associationはどのモデル同士がそのような関係で結びついているかを記載します。
has_many 参照元テーブル → 参照先テーブル
belongs_to 参照先テーブル → 参照元テーブル
has_one 1対1の関係
シンプルに書くこと、人によっては日本語でREADMEを書いてる方もいるそうです。設計図なので分かりやすく書くということが一番大事なのだと思います。