Upgrade to Pro
— share decks privately, control downloads, hide ads and more …
Speaker Deck
Features
Speaker Deck
PRO
Sign in
Sign up for free
Search
Search
Rubyリファレンスマニュアルをよりよくしよう!/lets-make-rurema-better
Search
ima1zumi
September 29, 2020
2
210
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
Reline 1分 Cooking
ima1zumi
0
4
続・mruby/cにUTF-8 を実装する
ima1zumi
0
3
UTF-8 is coming to mruby/c
ima1zumi
3
4.3k
たのしいString
ima1zumi
1
440
Watchから始めるOSS生活
ima1zumi
0
44
String meets Encoding
ima1zumi
2
2.4k
Emojiの正規表現
ima1zumi
0
3
RubyKaigiで話した話
ima1zumi
1
340
漢字が文字コードになる前の話
ima1zumi
0
3
Featured
See All Featured
The Straight Up "How To Draw Better" Workshop
denniskardys
227
130k
Why You Should Never Use an ORM
jnunemaker
PRO
50
8.6k
CSS Pre-Processors: Stylus, Less & Sass
bermonpainter
352
28k
The World Runs on Bad Software
bkeepers
PRO
61
6.7k
個人開発の失敗を避けるイケてる考え方 / tips for indie hackers
panda_program
60
14k
A better future with KSS
kneath
231
16k
Visualizing Your Data: Incorporating Mongo into Loggly Infrastructure
mongodb
34
8.8k
Music & Morning Musume
bryan
41
5.6k
Designing on Purpose - Digital PM Summit 2013
jponch
110
6.4k
Ruby is Unlike a Banana
tanoku
96
10k
Keith and Marios Guide to Fast Websites
keithpitt
408
22k
Raft: Consensus for Rubyists
vanstee
132
6.2k
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