雑文発散

▼ [Symfony2] Symfony2 のドキュメントに 404 があったので修正したら、コミュニティ運営について学ぶことができた

何かを調べていた流れで Symfony2 のドキュメントを眺めていたら、一部に 404 が発生するリンクがあるのを見つけた。

クラス名をクリックすると API リファレンスへジャンプするはずなのだが、オレが見つけたドキュメント内のいくつかのクラスはクリックすると Not Found が出る。

404 の画面を見て「へー、Symfony2 のドキュメントサイトは nginx を使っているんだなー」という豆知識を入手したところで満足しても良かったのだけれど、もしかしてと思って URL の一部を加工してみたら、該当のリファレンスが表示された。つまり、API リファレンスが存在しない訳ではなく、単にリンク元の URL が間違っているだけだということが分かった。

また、Symfony2 のドキュメントは GitHub で管理されていて、ドキュメントは Sphinx で書かれていることも分かった。それならオレにも修正できるな！と思って、手元で修正して pull request を投げた。

最初は（Symfony のバージョンの） 2.7 ブランチへ投げてしまったのだけど、「これが発生した一番古いブランチである 2.3 ブランチを修正すべき」という意見を貰ったので、2.3 ブランチでリトライした結果、マージして貰えた！

ちなみにこのコメントで貰った「2.3 ブランチにすべき」という話は、Symfony2 の「ドキュメントへのコントリビュートのドキュメント」に書かれていたので、ドキュメントよく読め案件であった。。。

Unless you're documenting a feature that was introduced after Symfony 2.3, your changes should always be based on the 2.3 branch. Documentation managers will use the necessary Git-magic to also apply your changes to all the active branches of the documentation.

でも、まぁ、マージしてもらえたので、これで Symfony2 のドキュメントに対しても少しだけ貢献できたってことだ。

symfony-docs へは初めて pull request を出したんだけど、ブランチ間違いをしていたオレに対してのコメントも丁寧だったし、「very nice catch!」だとか「awesome fix」だとか「ちょっと大げさじゃね？」と思わせつつも、コントリビューターのやる気を起こさせる言い方をしているのが印象に残った。次もやってやるぜ！みたいな気分になるよね、これ。

こういう丁寧なふるまいがオープンソース・プロジェクトやそのコミュニティ運営には大切なんだなぁと教わった気がする。