Ruby on RailsガイドにPull Requestを送ってみた

はじめに

以下のブログを読んでRailsガイドでOSS貢献してみたいなという気持ちがあったのと、ちょうどRailsガイドの誤記に気づいたのでプルリクを送ってみた。せっかくなので手順を残しておく。

blog.willnet.in

手順（2017/12/23現在）

手順の確認

下記ページの「フィードバックについて」および「Railsガイドの生成方法」を確認する。

GitHub - yasslab/railsguides.jp: Ruby on Rails Guides in Japanese (Railsガイド)

私が確認した内容は上記キャプチャの通りです。（今後変更があるかもしれませんので、作業前は最新のページを確認ください）

リポジトリをフォークする

フォークしたリポジトリをローカル環境にクローンする

$ git clone (githubからコピーしたパス)

クローンしたディレクリへ移動

$ cd railsguides.jp

ローカルリポジトリにブランチを追加してそのブランチへ移動（例：fix-typoブランチ）

$ git branch fix-typo
$ git checkout fix-typo

Ruby -vでRuby環境を確認

リポジトリには.ruby-versionファイルがある。ローカル環境に該当するバージョンがなければrbenv等でインストールする。

ファイルを修正する(/guides/source/ja 内の Markdown ファイルを編集する)

ローカルで修正結果を確認する

$ bundle install
$ bundle exec rake assets:precompile
$ bundle exec jekyll server

ブラウザでlocalhost:4000を指定し変更結果を確認する（問題があれば修正）。

問題なければ自分のアカウントのリモートリポジトリへPushする。

$ git add (修正したファイル)
$ git commit -m "(修正コメント：「Fix typo」など)"
$ git push

Pull Requestをする

「New pull request」をクリック

自分のリモートリポジトリ「(自分のアカウント名)/railsguides.jp」の「fix-typo」ブランチから「yasslab/railsguides.jp」の「master」へPull Requestする。

（キャプチャを撮り忘れてしまったのですが、下記情報を参考にプルリクしました）
【GitHub】Pull Requestの手順 - Qiita

実際のPull Request

github.com

感想

ほんのわずかではあるけど、初めてOSS貢献した。プルリクは自己学習で操作などはわかっていたし、普段Gitlabを使っていて概念はわかっているけど、実際にやってみると動作確認環境の構築でハマったり、どのブランチへプルリクを送れば良いか（過去のtypo修正のプルリクの調べるとjapaneseブランチへプルリクしてるようで、masterで良いか少し迷った）など、簡単にはいかなかった。本投稿も完全に細かく手順を記載しているわけではないけど、これからやってみようと思っている方への参考になればうれしい。