Tbpgr Blog

元エンジニア 人事 tbpgr(てぃーびー) のブログ

オープンソース開発 | はじめてのPull Request。Rails GuidesにPull Requestを送ってみたら瞬殺でマージされた

概要

はじめてのPull Request。Rails GuidesにPull Requestを送ってみたら瞬殺でマージされた

経緯

最近、ライブラリを覚えるのとOSSのコードリーディングも兼ねてRailsActiveSupportのGuideと
GitHubのコードを毎日読んでいました。

String#indentのGuideを読んでいたところ、他のメソッドのところにはあった
ソースコードの場所に関する記述がありませんでした。
これは記述があった方が便利だろう、ということで修正依頼もしくは修正する方法を調べてみることにしました。

ドキュメントに関するContributeのルールを読む

下記ページの項目6「Contributing to the Rails Documentation」を読みました。
http://edgeguides.rubyonrails.org/contributing_to_ruby_on_rails.html

GitHubRailsにPull Requestを送るか、定期的にメンテナンスをする場合はRails core teamに
連絡を取ってコミット権をもらうか、とのことだったので前者を選択。

また、注意事項にあるGuideの記述ルールを読みました。
http://edgeguides.rubyonrails.org/ruby_on_rails_guides_guidelines.html

Pull Requestの手順

・自分のアカウントでGitHubにログインして、Railsリポジトリにアクセス。
https://github.com/rails/rails
・Forkボタンを押します
・Forkされました

・Forkされたリポジトリをローカルにクローンします
・作業用のブランチを作成します。(guides_active_support_core_ext)
・ファイルを編集します。
https://github.com/rails/rails/blob/master/guides/source/active_support_core_extensions.md
・編集内容をcommitします。
この際、コメントに [ci skip] を含めます。

fix guide active_support_core_extensions. add Note to String#indent [ci skip]

※他の開発者がGuideのPull Requestを送った際に[ci skip]を追記するように指摘されていたので。
・編集したファイルをForkしたリポジトリにpushします
・Pull Requestを送ります
・ものの数分でマージされました!

https://github.com/rails/rails/pull/14059

しばらくしたらString#indentの Guidesのところにソースコードの場所を表す記述が追加されると思います。

Rails Guideでソースコードメソッドはあるけど、 Guidesに記述されていないものもありますので
Guidesを書いて初Pull Requestデビューしてみてはいかがでしょうか?