雑文発散

▼ [雑] Contributing Guidelines というものを知った

「世の中の『行儀の悪いメール』を集めておいて、メール関係のシステムを作る場合に容易に利用できるようにしよう！」というプロジェクトが https://github.com/milter-manager/test-mails にできたので、watch をしていたら、ひとつめの Issue が流れてきた。

pull request の作成時などに見てもらいやすくするために contribute.md は CONTRIBUTING.md に rename した方が良いのではないでしょうか。

https://github.com/blog/1184-contributing-guidelines

リンク先を辿ると、GitHub blog の「Contributing Guidelines」というページだった。

• オープンソースプロジェクトでは、CONTRIBUTING というファイル（.txt とか .md とか）をルートディレクトリに置いていることがあるよ。
• GitHub では、pull request や issue を登録する画面に CONTRIBUTING ファイルがあればリンクを表示して、登録者に読んでくれるように促すよ。

という内容のようだ。

こういった細かな配慮は、さすが GitHub というところなんだけど、オレがふと思ったのは別のこと。

こういう「貢献の仕方」のようなものは、オープンソース・ソフトウェアだけでなく、そのコミュニティサイトでもトップページに掲示しておくのが良いんじゃないかなぁ。

具体的な手続きを書くのは難しいにしても、「Webコンテンツの保守メンバーを募集しています」「ドキュメントの翻訳のお手伝いをして欲しいです」などの記載はしても良さそうに思うなぁ（既にやっているところもあるだろうけど）。

ということで、CakePHP の日本語ドキュメント、まだ翻訳が進んでいない状況です。Facebook の CakePHPドキュメント翻訳 グループがなんとなく日本でのドキュメント翻訳の中心になっているような気がするので、興味あれば参加をお願いしたいところです。

英語 → 日本語への翻訳はもちろんのこと、「日本語の文章がおかしいよ」とか、「実際のコードとドキュメントの動きが違うじゃねーか！」などの情報もあれば、ぜひ提供して頂けると。

あ、そうそう、オレ、CakePHP の本家リポジトリへのメンバーになったのですよ。push / merge できるのはドキュメントだけだけど。