訳注
これはcontributing.mdの日本語訳です。こちらがAVAのmasterブランチとの差分のリンクになります(このリンクをクリックして、contributing.mdに変更点が見当たらなければ、この翻訳が最新であることを意味します)。
✨ AVAにコントリビュートしてくれてありがとう! ✨
このプロジェクトはコントリビューターの行動規範に基づいてリリースされます。プロジェクトに参加することにより、この行動規範に従うことを同意することになります。
翻訳: Español, Français, Italiano, 日本語, Português
AVAのユーザーとして、ドキュメントを改善することは完璧に私たちの手助けになります。タイポの修正、エラーの修正、より良い説明、より多くの例、など。改善できることについてissueを作成してください。私たちのドキュメントを翻訳するのを手伝ってください。何でもいいです。このドキュメントの改善でも。
いくつかのissueは、情報が足りなかったり、バグの再現ができない、または単に間違って作成されています。これを解決しやすくするために手伝ってください。issueの処理に対してたくさんの時間がかかりますが、この時間はバグの修正や機能追加に費やせるはずです。
私たちはいつもissueトラッカーでより多くの意見や議論を求めています。それはAVAの将来の方向性に影響を与える良い機会となっています。
チャットがあります。参加して、話しかけて、みんなを手助けしてください。
- issueトラッカーはissueのためのものです。サポートが必要ならchatかStack Overflowを利用してください。
- issueを作成する前にissueトラッカーで検索してください。
- 最新バージョンのAVAを使用しているか確認してください。
- 明確で叙述的な見出しをつけてください。
- 可能な限りの情報を含めてください: issueを再現する手順、エラーメッセージ、Node.jsのバージョン、OS、など。
- issueを書くのに多くの時間をかけてください。私たちはより多くの時間をかけます。
- 最善のissueの報告はテストが失敗することで証明することです。
- 不要な作業をしてしまわないように、小さくない変更は最初にissueで議論するのが一番良いことが多いです。
- 大きなタスクであれば、フィードバックを可能な限り早く得るためにコミュニティに作業を見えるようにするべきです。アイディアを実現するのに必要最小限のことが完了したらすぐプルリクエストを出してください。この段階で完璧である必要も100%の状態である必要もありません。[WIP]プレフィックスを見出しに追加して、これからまだ必要なことを記述してください。そうすることで、詳細について小うるさくしなくても、また、すでにあなたが分かっている改善点を指摘しなくてもいいとレビューアーに知らせることになります。
- 新たな機能はテストとドキュメントを含めてください。
- 関連性のない変更を含まないでください。
- プルリクエストを送る前に
$ npm testを実行することでlintとテストを行ってください。 - masterからではなくトピックブランチからプルリクエストを作成してください。
- プルリクエストとコミットには明確で叙述的な見出しを使用してください。
- なぜプルリクエストを確認すべきなのか納得のいく理由を書いてください。私たちを納得させるのはあなたの役目です。"なぜ"それが必要なのかと、使用例を見せてください。
- あなたのプルリクエストに対して変更を求めることもあると思います。その場合新たに他のプルリクエストを作る必要は全くありません。すでに存在するプルリクエストを更新してください。