コーディングスタータープロジェクト
スタータープロジェクトを他の人と共有し、彼らも成長させるための基本的なリポジトリです！
まず、貢献するために時間を割いてくれてありがとう！
あらゆる種類の貢献が奨励され、評価されています。このプロジェクトがそれらを処理する方法についての支援と詳細については、さまざまな方法については、目次を参照してください。貢献する前に、関連するセクションを必ずお読みください。これにより、米国のメンテナーにとってはずっと簡単になり、関係者全員のエクスペリエンスをスムーズにします。コミュニティはあなたの貢献を楽しみにしています。
そして、あなたがプロジェクトが好きであるが、貢献する時間がないなら、それは大丈夫です。プロジェクトをサポートし、あなたの感謝を示す他の簡単な方法があります。
- プロジェクトに出演します
- それについてツイートします
- このプロジェクトをプロジェクトのREADMEで参照してください
- 地元のミートアップでプロジェクトに言及し、友達/同僚に伝えてください
目次
- 行動規範
- 質問があります
- 貢献したいです
- バグの報告
- 強化を提案します
行動規範
このプロジェクトとそれに参加している全員は、貢献している行動規範に準拠しています。参加することで、このコードを維持することが期待されます。容認できない動作を<>に報告してください。
質問があります
質問をしたい場合は、利用可能なドキュメントを読んだことがあると仮定します。
質問をする前に、あなたを助けるかもしれない既存の問題を検索することが最善です。適切な問題が発見されていて、まだ明確化が必要な場合は、この問題で質問を書くことができます。また、最初にインターネットを検索することをお勧めします。
それでも質問をする必要があり、明確化が必要だと感じた場合は、以下をお勧めします。
- 問題を開きます。
- あなたが遭遇しているものについて、できるだけ多くのコンテキストを提供します。
- 関連性に応じて、プロジェクトとプラットフォームのバージョン（Nodejs、npmなど）を提供します。
その後、できるだけ早くこの問題を処理します。
貢献したいです
法的通知
このプロジェクトに貢献する場合、コンテンツの100％を執筆したこと、コンテンツに必要な権利があり、貢献するコンテンツがプロジェクトライセンスの下で提供されることに同意する必要があります。
バグの報告
バグレポートを提出する前に
良いバグレポートは、他の人があなたを追いかける必要があることをより多くの情報のために追い払うべきではありません。したがって、レポートで慎重に調査し、情報を収集し、問題を詳細に説明するようお願いします。潜在的なバグをできるだけ早く修正するのに役立つように、次の手順を事前に記入してください。
- 最新バージョンを使用していることを確認してください。
- バグが実際にバグであり、互換性のない環境コンポーネント/バージョンを使用したエラーではないかどうかを判断します（ドキュメントを読んでいることを確認してください。サポートを探している場合は、このセクションを確認することをお勧めします）。
- 他のユーザーがあなたが抱えている同じ問題を経験した（そして潜在的に既に解決した）かどうかを確認するには、バグトラッカーにバグまたはエラーのために存在するバグレポートがまだないかどうかを確認します。
- また、インターネット（Stack Overflowを含む）を検索して、GitHubコミュニティ以外のユーザーがこの問題について議論しているかどうかを確認してください。
- バグに関する情報を収集します。
- スタックトレース（トレースバック）
- OS、プラットフォーム、バージョン（Windows、Linux、MacOS、X86、ARM）
- 関連性に応じて、通訳、コンパイラ、SDK、ランタイム環境、パッケージマネージャーのバージョン。
- おそらくあなたの入力と出力
- 問題を確実に再現できますか？また、古いバージョンで再現できますか？
良いバグレポートを提出するにはどうすればよいですか？
セキュリティ関連の問題、脆弱性、または機密情報を含むバグを問題トラッカーまたは他の場所に報告してはいけません。代わりに、敏感なバグは<>に電子メールで送信する必要があります。
GitHubの問題を使用して、バグとエラーを追跡します。プロジェクトの問題に遭遇した場合：
- 問題を開きます。 （この時点でそれがバグなかどうかはわかりませんので、バグについてはまだ話さないようにお願いします。問題にラベルを付けません。）
- あなたが期待する行動と実際の行動を説明してください。
- できるだけ多くのコンテキストを提供し、他の誰かが自分で問題を再現するために他の誰かが従うことができる複製の手順を説明してください。これには通常、コードが含まれます。適切なバグレポートの場合、問題を分離し、テストケースを削減する必要があります。
- 前のセクションで収集した情報を提供します。
提出されたら：
- プロジェクトチームは、それに応じて問題にラベルを付けます。
- チームメンバーは、提供された手順で問題を再現しようとします。問題を再現するための複製手順がない場合、または明らかな方法がない場合、チームはそれらの手順を尋ね、問題を
needs-reproとしてマークします。 needs-reproタグを使用したバグは、再現されるまで対処されません。 - チームがこの問題を再現できる場合、それは
needs-fixにマークされ、場合によっては他のタグ（ criticalなど）とマークされ、問題は誰かによって実装されるために残されます。
強化を提案します
このセクションでは、Contributing.mdの拡張提案を提出することをガイドします。これらのガイドラインに従うことで、メンテナーとコミュニティがあなたの提案を理解し、関連する提案を見つけるのに役立ちます。
強化を送信する前に
- 最新バージョンを使用していることを確認してください。
- ドキュメントを注意深く読んで、個々の構成によって機能が既にカバーされているかどうかを確認してください。
- 検索を実行して、拡張がすでに提案されているかどうかを確認します。ある場合は、新しい問題を開く代わりに、既存の問題にコメントを追加します。
- あなたのアイデアがプロジェクトの範囲と目的に適合するかどうかを調べてください。この機能のメリットをプロジェクトの開発者に納得させるために強力な主張をするのはあなた次第です。小さなサブセットだけでなく、大多数のユーザーに役立つ機能が必要であることに留意してください。少数のユーザーをターゲットにしている場合は、アドオン/プラグインライブラリを書くことを検討してください。
良い機能強化の提案を提出するにはどうすればよいですか？
拡張提案は、Githubの問題として追跡されます。
- 問題に明確で説明的なタイトルを使用して、提案を特定します。
- できるだけ多くの詳細で提案された強化の段階的な説明を提供します。
- 現在の動作を説明し、代わりにどの動作が見られるか、そしてその理由を説明してください。この時点で、どの代替手段があなたのために働かないかを知ることもできます。
- スクリーンショットとアニメーションGIFを含めて、手順を実証したり、提案が関連している部分を指摘したりすることをお勧めします。このツールを使用して、MacOSとWindowsにGIFを記録できます。このツールまたはLinuxにこのツールを記録できます。
- この強化がほとんどの貢献者にとって有用である理由を説明してください。MDユーザー。また、それをより良く解決し、インスピレーションとして役立つ他のプロジェクトを指摘することもできます。
