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
240
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
Ruby Taught Me About Under the Hood
ima1zumi
6
14k
Exploring Reline: Enhancing Command Line Usability
ima1zumi
1
86
10年物のRailsアプリにキャッチアップ!〜コードを読まずに理解したかった〜
ima1zumi
0
93
RubyKaigiの登壇者一覧ページを作った
ima1zumi
0
410
Relineのその後の生活
ima1zumi
0
230
IRB and Reline Kaigi 2024
ima1zumi
0
15
Exploring Reline: Enhancing Command Line Usability
ima1zumi
3
14k
Reline 1分 Cooking
ima1zumi
0
38
続・mruby/cにUTF-8 を実装する
ima1zumi
1
29
Featured
See All Featured
Unsuck your backbone
ammeep
671
58k
Evolution of real-time – Irina Nazarova, EuRuKo, 2024
irinanazarova
8
810
Balancing Empowerment & Direction
lara
1
420
Imperfection Machines: The Place of Print at Facebook
scottboms
267
13k
4 Signs Your Business is Dying
shpigford
184
22k
Six Lessons from altMBA
skipperchong
28
3.9k
[RailsConf 2023] Rails as a piece of cake
palkan
55
5.7k
YesSQL, Process and Tooling at Scale
rocio
173
14k
The World Runs on Bad Software
bkeepers
PRO
69
11k
Fireside Chat
paigeccino
37
3.5k
Raft: Consensus for Rubyists
vanstee
140
7k
Navigating Team Friction
lara
187
15k
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