オープンソースに貢献する最も簡単な方法——ドキュメント修正から始めよう

この記事は、Dohyung Ahnさんのおかげで韓国語版も公開されています。

以前の記事へのコメントで、Thom Parkinさんが素晴らしい指摘をしてくれました。

素晴らしいアドバイスですね。ただ、非常に重要な[最後の]ポイントが一つ抜けています。オープンソースなのですから、ドキュメントが不十分だと気づいた機能の詳細を調べたら、その内容をドキュメントに反映してプルリクエストを送るべきです。そうすればコミュニティ全体が恩恵を受けられますし、貢献者として「コーダーとしての信用」を得られることさえあります!

この指摘を挙げてくれたThomさんには感謝しています。それほど重要なことだからです。ドキュメントの修正は、自分が使って愛しているプロジェクトへ還元を始めるための、最も簡単な方法なのです。

私自身、RailsやRubinius、Elixirといったプロジェクトへの最初の貢献は、すべてドキュメントの修正でした。わかりやすくするための小さな手直し、コードを読まないと分からない事柄の説明追加、壊れた書式の修正など。いずれも短時間でできる、大きなオープンソースプロジェクトを助ける手軽な方法でした。それがそのプロジェクトへの唯一の貢献だったとしても、将来のユーザーだけでなく、未来の自分自身をも助けています。それこそがオープンソースの本質だからです。

なぜドキュメント修正が最初の一歩に最適なのか

Railsのような大規模プロジェクトへの貢献として、ドキュメント修正ほど心理的なハードルが低いものはありません。

• バグ修正と違って、プロジェクトをセットアップする必要がない。ドキュメントの更新だけなら、テストやアプリを動かす環境構築は不要です。場合によってはプロジェクトをローカルにクローンする必要すらなく、GitHub上で直接編集できます。

• メンテナーからプルリクエストの修正を求められても、それはたいてい言い回しや好みの問題。自分のコードへの批判よりも受け入れやすいものです。しかも修正も簡単で、テストやコードではなく言葉を直すだけですみます。

• ドキュメント作成はメンテナーにとって難しい作業なので、更新はとても喜ばれる。作者はコードに近すぎるため、どこが分かりにくいのか把握できないことがよくあります。新しく参入した開発者が「ここが分かりにくい」と伝えてくれる必要があるのです。初心者の目線で自分のプロジェクトを見るのは訓練が必要で、誰もが身につけているスキルではありません。

• 影響の小さな変更を通じて、メンテナーとの関係づくりを始められる。機能一式を丸ごと提案するときのような、プロジェクトの方向性を変える変更ではありません。そのぶんメンテナーもレビューしやすく、通常はより早く反応してくれます。マージリクエストが「これは良いアイデアなのか?」という段階で足止めされることもありません。

こうした関係を積み重ねていくと、信頼できるコントリビューターとして見てもらえるようになります。プルリクエストのレビューは速くなり、より複雑な機能追加やバグ修正についても、お互いに話し合いやすくなります。

始めるのが簡単で、取り組むのも簡単で、マージされやすい。ならば、最初の貢献をドキュメント修正にしない理由はないでしょう。

ドキュメント改善への貢献を始めるには

ドキュメント更新の貢献とバグ修正に共通する重要な点があります。どちらも「何かおかしい」と感じる感度に頼っているということです。常に注意を払うことが大切です。

予想外の動作に出くわしたら、それはドキュメントを更新すべきタイミングかもしれません。問題を解決するためにコードを読み込む羽目になったら、その知見を他の人にも伝えたくなるはずです。読んでいるドキュメントの崩れた書式や誤字にも敏感になりましょう。あなたが直さなければ、誰が直してくれるのでしょうか?

どこをどう書き換えるべきかイメージが固まったら、実際に変更を加えてGitHub経由でプルリクエストを送りましょう。

まだベストな更新方法を迷っている段階なら、GitHubでissueを立てるのも良い方法です。たとえば次のように書きます。

「ここが私には分かりにくかったのですが、次のように書き換えようと思っています:……。いかがでしょうか? 他に触れておくべきことはありますか?」こうやって一緒に、全員が納得できる表現を練り上げることができます。

最後に、返信がなくても落ち込まないでください。大きなプロジェクトでは動きが多く、あなたの貢献が埋もれてしまうことも珍しくありません。1週間ほど経っても反応がないようなら、もう一度メンテナーに声をかけてみましょう。

ドキュメントはライブラリを使い始めるときに最初に触れるものです。だからこそ、詳細で明確であることが重要なのです。

使っているコードに戸惑ったとき、ソースを読み込むことになったときは、次に来る人のために道しるべを残しましょう。手早く更新を書いて、プロジェクトに還元する。それこそが、私の知る限り最も簡単なオープンソースコントリビューターのなり方です。

この記事は、もともと私のメーリングリストの読者に向けて送ったものです。同様の記事をもっと読みたい方は、こちらから登録してください!