https://uniquevision.connpass.com/event/187447/
Rubyリファレンスマニュアルをよりよくしよう!2020-09-29@ima1zumi1
View Slide
⾃⼰紹介@ima1zumi (いまいずみ)FJORD BOOT CAMP というスクールで Ruby や Ruby on Rails学習中2
話すきっかけRubyリファレンスマニュアルで Ruby 2.7.0 対応されていないところを⾒つけたPRを送ってマージされたPRを送る⼈が増えたらいいな3
Ruby リファレンスマニュアルRuby リファレンスマニュアル 略して「るりま」ちなみに「るびま」は Rubyist Magazine の略で使われることが多い4
どうやって管理されているの?GitHub で管理されているドキュメントは 簡単に記述できる rd ファイルで出来ているrd ファイルを BitClust で HTML に変換している直感的に書ける5
誰が更新しているの?コミッター⾃⼰申告制ボランティアでメンテナンスしてくれているコントリビューターるりまにPRやissueを⽴てる⼈誰でもコントリビューターになれる!Slack ruby-jp に #rurema チャンネルがある6
るりまで気になるところを⾒つけたら1. issue を⽴てる2. PR を送る7
issueを⽴てる例:ドキュメントの単純な誤り指摘 (バージョン間違いなど)ドキュメントをよりよくするための提案 (説明⽂追加など)あるメソッドのサンプルコード提供既に上がっているIssueに対するコメント8
PRを送るrd ファイル⽤の記法を使わない=> GitHub 上で直接修正するrd ファイル⽤の記法を使う=> fork して修正して HTML を確認して push する9
GitHub上で直接修正する右上の [edit] リンクからGitHub上で直接修正ができる10
forkしてローカルで修正してPRを送る1. fork する2. clone して.rdファイルを修正する3. bitclust を⼊れて修正したファイルをプレビューする$ gem install bitclust-core bitclust-dev refe2$ bitclust setup$ bitclust htmlfile ./refm/api/src/_builtin/Array --target=Array#pop --ruby=2.5.0 > /tmp/Array_pop.html4. commit して PR を送る11
参考Tutorial · rurema/doctree WikiReferenceManualFormatDigest · rurema/doctree WikiBitClust · rurema/doctree Wiki12
るりまに気軽にPRを送ろう13