目的
RailsGuidesを参考にプログラムを動かしてみたら思ったとおりに動作しないときなど、RailsGuidesに問題があったときに修正してPRを出す手順を記載する。
手順
RailsGuidesをGithubでforkする。
RailsGuidesのPRはforkしたリポジトリでブランチをpushして、本体にPRする流れになる。
RailsGuidesをクローンする
$ git clone https://github.com/<forkしたアカウントID>/railsguides.jp.git
RailsGuidesをローカルで起動する
$ bundle install
$ bundle exec rake assets:precompile
$ bundle exec jekyll server
http://localhost:4000 にアクセスする。
RailsGuidesを編集する
まずは master ブランチから patch-1 というブランチを切る（数字の1はPR回数が増える毎に加算する。自分がそうしているだけで、もしかしたら正しくないかもしれない）。
$ git branch patch-1 master
$ git checkout patch-1
エディタで /guides/source/ja 配下の対象ファイル(.md)を探して編集する。
railsguides.jpで修正したいページをブラウザで開いていれば、URLから対象ファイル名が分かると思うのでファイルはすぐに見つかると思う。
https://railsguides.jp/<ここがmdファイル名と一致する>.html
編集が完了したら、 add / commit / push する。
push したら、本体（yasslab/railsguides.jp）のGithubを見るとPRできるようになっているので、PR内容を分かりやすく書いてマージのお願いをする。
PRする前に気をつけること
Rails本家も確認してみる
誤訳ではなく、コードのミスなどRailsGuide(本家)にも影響がありそうな場合は、既に修正されているかどうか確認してみる。（Railsコミッターになれるチャンス？）
ただし、本家はEdgeGuidesという最新の修正コミットを適用したページもあるので、そちらで修正されていれば本家は既に修正済みになるので注意が必要。
修正内容をもう一度確認する
文章を校正するなら本当に読みやすくなっているかとか、コードを修正するなら実際に実行して動作確認を取って間違いがないことを確認する。（当たり前だけど念の為）
実際にやってみたPRリスト
| PRリスト | 概要 |
|---|---|
| #702 | 「Active Record コールバック after_touch」の出力結果を修正 |
| #707 | 「ActionView概要 コレクションを出力する」のコードを修正 |
更にやってみたこと
| PRリスト | 概要 |
|---|---|
| rails #33898 |
Improve readability in form helpers guide [ci skip] |
| rails-jp #712 |
Improve readability in form helpers guide by white space |
参考
RailsGuides日本語訳README
この記事が古くなったら手順が変わっているかもしれないので、READMEを参考にすることを推奨する。
自分のブログ
#702 に対してどういう経緯で修正したか、何が問題だったのかを紹介している。