Upgrade to Pro — share decks privately, control downloads, hide ads and more …

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

ima1zumi
September 29, 2020
200

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

ima1zumi

September 29, 2020
Tweet

Transcript

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

    View full-size slide

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

    View full-size slide

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

    View full-size slide

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

    4

    View full-size slide

  5. どうやって管理されているの?
    GitHub で管理されている
    ドキュメントは 簡単に記述できる rd ファイルで出来ている
    rd ファイルを BitClust で HTML に変換している
    直感的に書ける
    5

    View full-size slide

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

    View full-size slide

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

    View full-size slide

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

    View full-size slide

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

    View full-size slide

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

    View full-size slide

  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

    View full-size slide

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

    View full-size slide

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

    View full-size slide