Railsコントリビュータへの道

be_a_rails_contributer.md

これはなに

• Railsにプルリクストを送るときに知っておくと便利なお作法集
• Railsにプルリクエストを送りたいけど何から始めたらいいのかわからない人向けの指針

お作法についてはRuby on Rails に貢献する方法 | Rails ガイドを参考にしています。

前提知識

Railsのコードを読むには、最低限次の二つの知識があったほうがよいです

• メタプログラミングRubyを読了した程度のRubyの知識
• 読もうとしている機能に関する知識をRuby on Rails ガイドなどで得ておく

テスト環境

• rails 自体のテストは rails-dev-box にある vagrant 環境越しにやります
• 基本的に各ライブラリ(例: activerecord)のディレクトリで rake test して実行します。全体は時間かかりすぎる＞＜

rails で単体のテストファイルを実行する方法

bundle exec ruby -w -Itest:lib テストファイル名

ex)
bundle exec ruby -w -Itest:lib test/core_ext/hash_ext_test.rb

単体ファイルの特定のテストを実行する方法

bundle exec ruby -w -Itest:lib テストファイル名 -n テスト名

ex)
bundle exec ruby -w -Itest:lib test/core_ext/hash_ext_test.rb -n test_transform_keys

Issue のお作法

• Issue にテンプレートがあるのでそれを埋めましょう
• 再現コードのひな形あるのでそれを参考に動く再現手順を作りましょう
• 他の人が作ったIssueに再現手順がなかったら、つくってあげると喜ばれるかも

PR のお作法

• ドキュメントやコメントの typo 修正は、コミットに [ci skip] を必ずつけること
• PRのテンプレートがあるのでなるべく埋めましょう
• コミットはなるべく一つにまとめましょう
  • PRした後に指摘来たらsquashせずにコミットを追加
  • マージする段階になったらsquashしてねと言われるはず
• バグ修正以外のPRは、「このPRが入るとなにが良くなるのか」をなるべく具体的に書きましょう
  • ここが明確でないPRは放置されたりcloseされたりしがち

PR するためになにをすると良いか

• edge Rails をなるべく毎日さわる。
  • 新機能が追加されたら一通り使ってみるとバグに気づきやすい
• TODO: や FIXME: で検索する
• DHH が立てた Issue をウォッチする
• コミットを読む
  • なるようになるブログ をウォッチするとべんり
• コードを読む
  • 最初は ActiveSupport が読みやすいのでオススメ
• マージされると Rails Contributors に自分の名前が載るので見てニヤニヤしましょう

便利なサービス

登録したOSSのPRやIssueを毎日メールで通知してくれる

CodeTriage

その他

• rails は travis ci を使っているけれど、どうやら rails を fork したプロジェクトでは travis を動かせない模様
  • Travis CIさんのツイート: "Please do not add your Rails fork to Travis, the Ruby workers are not tuned to handle the Rails test suite, this may change in the future"

私はあと以下のような事を気にしてたりします。ご参考までに。

• コードを書く際はRailsコーディングルールに従う
• 再現コードのひな形は、Active Record用 / Action Controller用 / その他用で3種、そしてそれぞれmaster用 / gem用の合計6種類あるので、必要に応じて適切なものを選ぶと良い
• 既にissueがあるバグの修正を行う際は、コミットログにそのissueの番号を入れる。そうするとPRとissueが自動で紐付けられるので、何のバグfixかわかりやすくなる。
  • 例) Don't blank pad day of the month when formatting dates · rails/rails@2c5a8ba
• 性能改善の対応を行う場合は、コミットログにベンチマークに使用したスクリプト、及びその結果をまるまる含んでしまう
  • 例) remove object hash cache · rails/rails@13c4cc3
• Active RecordのテストはデフォルトでMySQL / PostgreSQL / SQLite3それぞれのDBに対してテストが実行されるので、割と時間がかかる。 特定のDBに対してだけテストを行いたい場合は、ARCONNでDBを指定してテストを行う。 また、DBに依存しないテストを行いたい場合は、SQLite3のin-memory DBを使用する。大分早くい。詳細はRUNNING_UNIT_TESTS.rdoc参照。

👍