Ruby

Rubyリファレンスマニュアル「るりま」の誤字などを見つけた時の貢献フロー

More than 3 years have passed since last update.


Rubyリファレンスマニュアル「るりま」の誤字などを見つけた時の貢献フロー


概要

Rubyを継続的に使っている方なら、おそらく 誰もがお世話になっている Rubyリファレンスマニュアル。

このRubyリファレンスマニュアル「るりま」の誤字などを見つけた時の貢献フローとして、

実際にプルリクエストをマージしていただいたので、例としてまとめます。


経緯

下記を確認していたところ、サンプルコードのインデントが揃っていない箇所をみつけました。

http://docs.ruby-lang.org/ja/2.0.0/class/UnboundMethod.html

class Foo

def foo
p :foo
end # => ここが揃っていない
@@orig_foo = instance_method :foo
def foo
p :bar
@@orig_foo.bind(self).call
end
end


報告方法を確認


  • 下記URLを確認

http://doc.okkez.net/2.0.0/view/help

間違いを見付けた場合は

https://github.com/rurema
へお願いします。

とのこと。


  • 該当リポジトリをみてみる。

https://github.com/rurema

複数のリポジトリが一覧表示されている。 doctree が日本語マニュアルのプロジェクトのようなので移動。

https://github.com/rurema/doctree


  • どうやって貢献するか確認

ここにまとめてありました。

https://github.com/rurema/doctree/wiki/HowToContribute

rurema/doctreeへのPull Requestだとより修正を適用するのが楽です。

と、記載されてあったことと、実際に過去のIssueの履歴を見ると typo の修正をプルリクエストとして

送っている方が複数名いらっしゃたので真似ることにする。


プルリクエストまで


  • 日本語リファレンスを下記ページから Fork します

https://github.com/rurema/doctree



  • Fork されました

https://github.com/tbpgr/doctree


  • ローカル環境に clone します

git clone git@github.com:tbpgr/doctree.git


  • トピックブランチを作成します

$ git checkout -b fix_unbound_method_sample_indent


  • 修正をします

doctree / refm / api / src / _builtin / UnboundMethod

diff

     def foo

p :foo
- end
+ end


  • commitします

$ git add -A

$ git commit -m "Fix sample code indent"


  • トピックブランチをpushします

$ git push origin fix_unbound_method_sample_indent


  • GitHubの fork したリポジトリで Compare & pull request を実行してプルリクエストを送る


  • 翌日、マージしていただきました


https://github.com/rurema/doctree/pull/107


参照

るりま

http://docs.ruby-lang.org/ja/

るりまサーチ

http://docs.ruby-lang.org/ja/search/