Rubyリファレンスマニュアルをよりよくしよう！/lets-make-rurema-better

Transcript

1. Rubyリファレンスマニュアルを よりよくしよう！ 2020-09-29 @ima1zumi 1

2. ⾃⼰紹介 @ima1zumi (いまいずみ) FJORD BOOT CAMP というスクールで Ruby や Ruby

   on Rails 学習中 2

3. 話すきっかけ Rubyリファレンスマニュアルで Ruby 2.7.0 対応されていないと ころを⾒つけた PRを送ってマージされた PRを送る⼈が増えたらいいな 3

4. Ruby リファレンスマニュアル Ruby リファレンスマニュアル 略して「るりま」 ちなみに「るびま」は Rubyist Magazine の略で使われることが多 い

   4

5. どうやって管理されているの？ GitHub で管理されている ドキュメントは 簡単に記述できる rd ファイルで出来ている rd ファイルを BitClust

   で HTML に変換している 直感的に書ける 5

6. 誰が更新しているの？ コミッター ⾃⼰申告制 ボランティアでメンテナンスしてくれている コントリビューター るりまにPRやissueを⽴てる⼈ 誰でもコントリビューターになれる！ Slack ruby-jp に

   #rurema チャンネルがある 6

7. るりまで気になるところを⾒つけたら 1. issue を⽴てる 2. PR を送る 7

8. issueを⽴てる 例: ドキュメントの単純な誤り指摘 (バージョン間違いなど) ドキュメントをよりよくするための提案 (説明⽂追加など) あるメソッドのサンプルコード提供 既に上がっているIssueに対するコメント 8

9. PRを送る rd ファイル⽤の記法を使わない => GitHub 上で直接修正する rd ファイル⽤の記法を使う => fork

   して修正して HTML を確認して push する 9

10. GitHub上で直接修正する 右上の [edit] リンクからGitHub上で直接修正ができる 10

11. 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.html 4. commit して PR を送る 11

12. 参考 Tutorial · rurema/doctree Wiki ReferenceManualFormatDigest · rurema/doctree Wiki BitClust

    · rurema/doctree Wiki 12

13. るりまに気軽にPRを送ろう 13