7
3

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

Railsガイドへコントリビュートするまでの経緯とそこから得られたもの

Last updated at Posted at 2024-09-24

はじめに

僕はエンジニアになって約1年です。

これまでOSS活動とは無縁だったのですが、ここ1ヶ月くらいでRailsガイドの日本語版・英語版の修正によるOSSコントリビュートが複数回できました。

日本語版(全4件)

英語版(全3件)


どれも誤字脱字を修正しただけですが、この経験を通じてドキュメント修正がOSS活動の第一歩として最適だと肌で感じました。

そこでこの記事では、Railsガイドにコントリビュートするまでの経緯とその過程で得られたものについて、自らの経験をもとにまとめます。

  • OSSってなんだか難しそうだけど挑戦してみたい
  • ドキュメント修正なら手軽にできるかもしれないな
  • 最初の一歩としてドキュメント修正でコントリビュートしてみたい

上記に当てはまるエンジニアはぜひ最後まで読んでみてください。

経緯

エンジニアになってから1年が経ち、日々の業務にはある程度慣れてきました。

そこで次の目標として掲げたのがOSSへのコントリビュートです。

OSSへの貢献を通じてスキルアップするとともに、対外的な実績も確保できて一石二鳥だと考えました。

しかしその一方で以下の課題もあり、なかなか思うように進みませんでした。

  • gemのコードが難しくて読み解くだけでも一苦労
  • どのgemを対象とすべきかわからない
  • そもそも詳しく挙動を知っているライブラリが少ない

これらの課題を解消するため、まずは手軽にできるドキュメント修正から始めようと考えました。

そこで目をつけたのがRailsガイドでした。

困ったことと解決策

「Railsガイドのドキュメント修正でOSS貢献の第一歩を踏み出そう」と決意したものの、実際にコントリビュートするまではいくつか困ったことがありました。

①修正すべき箇所が見つからない

そもそも修正箇所を見つけられる気がしませんでした。

ひたすら誤字脱字を探すのはつまらないし、それ自体はスキルアップにも繋がりません。

かといって網羅的に最初から1ページずつ読んでいくのも時間がかかるため挫折してしまいます。

「いったいどうやってコントリビュートのチャンスが見つけられるんだろう」

始めてからしばらくは可能性を全く感じられず途方に暮れていました。

解決策

コントリビュートのためにまとまった時間を確保するのではなく、日々の業務や学習のなかでRailsガイドに目を通す頻度を増やしていきました。

  • わからないことがあったらまずRailsガイドに目を通す
  • QiitaやZennなどの記事で疑問が解消した場合も「Railsガイドにはどう書かれているか」を必ず確認する
  • 以前に調べたことをド忘れしただけの場合でもいちいちRailsガイドまで見にいく
  • 翻訳の都合でわかりにくい箇所は原文まで確認する
  • 文章だけだと頭に入ってこない箇所は手を動かして動作確認する

これらを継続した結果、徐々に土地勘のあるページが増えていき、誤字脱字や言い回しなど細かい部分にも自然と意識が向けられるようになりました。

「ドキュメントを読む習慣を確立することで自然とコントリビュートのチャンスが見つかる」

OSS貢献とスキルアップを両立したければ、このスタンスが大切だと思います。

②コミュニティのルールや作法がありそうで不安

OSS活動においては、コミュニティ内のルールや作法が厳格に定められており、それを遵守しないと相手にしてもらえないイメージがありました。

こうした振る舞いの部分にもハードルの高さを感じていたのです。

コミュニケーションの取り方や過去に類似のPRやIssueが存在していないかなど、入念な準備が求められる印象を持っていたため、躊躇してしまう自分がいました。

解決策

RailsガイドのREADMEではブラウザ上で直接修正する方法がオススメされていました。

細かいルールも存在しなかったです。

これが非常にありがたく、心理的にソワソワすることなく取り組むことができました。

Railsガイドへのコントリビュートで得られたもの

ただ誤字脱字を見つけて修正しただけなので、難しいことをやり遂げたわけではないです。

それでもOSS貢献の最初の一歩を踏み出せたことで得られたものがたくさんありました。

1. 自信と満足感

「自分でもコントリビュートできた」

「最初の一歩が踏み出せた」

こういった満足感が高く、大きな自信を得られました。

「OSS活動なんて強者揃いで自分には手が届かない」と思っていましたが、少しばかり身近になった感覚です。

初歩的な内容でもはじめの一歩としてのドキュメント修正は大きな自信に繋がります。

2. 技術力

同じページであっても何度も繰り返し読んだことで、着実に知識が定着したように思います。

仕事で問題があった時も「たしかRailsガイドに書いてあったような」と目星をつけやすくなってきました。

意識的に読む頻度を増やすことで問題解決に役立てる機会が大きく増加したのです。

このように、元々はコントリビュートが目的でしたが、結果的にスキルアップにも繋がりました。

3. 読解力

ドキュメントに対する読解力や耐性も向上したように思います。

コントリビュートを意識しつつ読むことで、内容を常に吟味する癖がついたからです。

「なぜこの実装方法を推奨しているんだろう?」とか「この言い回しにはどういう意図があるんだろう?」と常に能動的にドキュメントを読めるようになってきました。

過去の自分と比べると明らかに読んでいる時の感覚が異なります。

おわりに

Railsガイドへのコントリビュート経験によって、スキル・モチベーションの両面でポジティブな効果が得られました!

まだOSS活動を始めてないけどこれからトライしてみたい方はぜひ、ドキュメント修正から最初の一歩を踏み出してみてください!

次はコード修正でのコントリビュートを目指して頑張っていきたいと思います!

7
3
3

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
7
3

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?