Upgrade to Pro
— share decks privately, control downloads, hide ads and more …
Speaker Deck
Speaker Deck
PRO
Sign in
Sign up for free
Rubyリファレンスマニュアルをよりよくしよう!/lets-make-rurema-better
ima1zumi
September 29, 2020
2
160
Rubyリファレンスマニュアルをよりよくしよう!/lets-make-rurema-better
https://uniquevision.connpass.com/event/187447/
ima1zumi
September 29, 2020
Tweet
Share
More Decks by ima1zumi
See All by ima1zumi
RubyKaigiで話した話
ima1zumi
1
230
Dive into Encoding
ima1zumi
4
1.1k
RubyのStringとencodingと / ruby-string-and-encoding
ima1zumi
2
150
めくるめくEmojiの世界/emoji-world
ima1zumi
5
2.1k
文字もじemojiよもやま話 / moji-moji-emoji
ima1zumi
0
98
クラスメソッドとは何なのか / whats-class-method-20200822
ima1zumi
0
610
Railsでフォロー機能を作るためのモデルの書き方
ima1zumi
1
500
Featured
See All Featured
jQuery: Nuts, Bolts and Bling
dougneiner
56
6.4k
RailsConf & Balkan Ruby 2019: The Past, Present, and Future of Rails at GitHub
eileencodes
119
28k
What's in a price? How to price your products and services
michaelherold
229
9.3k
10 Git Anti Patterns You Should be Aware of
lemiorhan
638
52k
Fashionably flexible responsive web design (full day workshop)
malarkey
396
62k
4 Signs Your Business is Dying
shpigford
169
20k
The MySQL Ecosystem @ GitHub 2015
samlambert
238
11k
Java REST API Framework Comparison - PWX 2021
mraible
PRO
11
4.6k
Responsive Adventures: Dirty Tricks From The Dark Corners of Front-End
smashingmag
237
19k
WebSockets: Embracing the real-time Web
robhawkes
57
5k
VelocityConf: Rendering Performance Case Studies
addyosmani
316
22k
We Have a Design System, Now What?
morganepeng
35
2.9k
Transcript
Rubyリファレンスマニュアルを よりよくしよう! 2020-09-29 @ima1zumi 1
⾃⼰紹介 @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.html 4. commit して PR を送る 11
参考 Tutorial · rurema/doctree Wiki ReferenceManualFormatDigest · rurema/doctree Wiki BitClust
· rurema/doctree Wiki 12
るりまに気軽にPRを送ろう 13