CONTRIBUTING.md

[boke0]

概要

CONTIBUTING.mdを作成し、設置しましょう。
外部の人がコントリビュートするときのガイドラインみたいなものを書くみたいです。

CONTRIBUTINGファイルとは、あなたのプロジェクトを見ている人に、どうすればそのプロジェクトに参加できるのかを伝えるものです。たとえば、以下のような情報です:

• どうやってバグリポートを提出するか（イシューとプルリクエストのテンプレートを使ってください）
• どうやって新しい機能を提案するか
• どうやって環境設定を行い、テストを行うか

技術的な詳細に加えて、CONTRIBUTINGファイルはどんなことをコントリビュートしてほしいのか伝えます。たとえば:

• どのような種類のコントリビューションをしてほしいか
• 今後のロードマップやビジョン
• どのような手段であなたに連絡を取るべきか（取るべきでないか）

温かい心をもって、友好的な口調で、やってほしいコントリビューションを具体的に伝えましょう（たとえばドキュメンテーションを書くこと、ウェブサイトを作ること）。これからの長い道のりを、新しく参加してくれた人々は、歓迎されている喜びを感じながら、ワクワクした気持ちでプロジェクトに参加することができます。
引用:コントリビュートのガイドラインを書く

だそうです。

タスク

• scripts/generate_readme.pyを改造してscripts/generate_contributing.pyを作成
• files/templates/CONTRIBUTING.jinja.mdを追加
• files/contributing/{ja, en}.jsonを追加

資料

• Active Adminの例
• Djangoの例
• Flaskの例

完了条件

タスク終われば良いかも。このファイルのアプデも随時書けていきましょう。