CONTRIBUTING テンプレート

コントリビューションの種類

プロジェクトがどのような種類のコントリビューションを求めているのか、ここに情報を提供してください。例えば、バグレポート、ユーザーの質問に対する回答、ドキュメントの改善、バグの修正、新機能の実装などです。

バグレポート

バグレポートの提出方法に関する情報をここに追加してください。これには、問題を再現し修正するためにプロジェクトがどのような情報を必要とするかについてのヒントが含まれるべきです。また、よく見られるバグのような設定ミスの情報も含めることができます。

また、初動までの時間やその後のプロセスなどに関して、コントリビューターが期待すべき情報についても記載してください。

機能リクエスト

機能リクエストを提出する方法についての情報をここに追加してください。また、初動までの時間やその後のプロセスなど、コントリビューターが期待すべき情報についても記載してください。

ドキュメントに対するコントリビューション

プロジェクトが遵守しているドキュメントのベストプラクティスや、ドキュメントの構築方法、チェック方法、プロジェクトに変更を戻す方法などの情報を含めてください。

ソースコードに対するコントリビューション

このセクションでは、以下の情報を提供します。

  • プロジェクトのソースコードにアクセスする方法

  • プロジェクトの一般的なレイアウト

  • 開発環境に対する要求事項

  • コードの書式に関するガイドライン

  • テストの実行方法

トラステッドコミッターになるには

このセクションでは、トラステッドコミッターになるためのプロセスがコントリビューターに開かれている場合、そのプロセスを明示する必要があります。

トラステッドコミッターをノミネーションする方法

このセクションは、既存の トラステッドコミッターへのリマインダーと、新しい トラステッドコミッターへの説明として、他のメンバーをホストチームに追加する方法について説明するものです。繰り返しになりますが、この情報は組織内のすべてのプロジェクトで同じものであることが理想的で、ここから中央の情報にリンクさせることができます。

最終更新