あなたのPythonパッケージのCONTRIBUTINGファイル#

CONTRIBUTING.md は、あなたのプロジェクトの貢献者のためのランディングページガイドです。貢献者の参加方法、歓迎する貢献の種類、貢献者があなたやメンテナチームとどのように関わり合うべきかについて概説しています。コントリビューターガイドは、開発環境のセットアップ方法や、GitHub/GitLabでどのようなワークフローを想定しているかなど、コントリビューターが始めるために必要なことをまとめたスタートアップリソースにもリンクしておくべきです。

このファイルは、メンテナと貢献者に利益をもたらします。コントリビューターにとっては、最初のコントリビューションを容易にするためのロードマップとなります。 メンテナにとっては、よくある質問に答え、貢献したいすべての人にあなたのプロセスを説明する負担を減らすことができます。この文書は、すべての人にとって、より協力的で効率的な開発プロセスを生み出します。

参入障壁の低減に CONTRIBUTING ファイル#

コントリビュートファイルは、ロードマップを提供するため、新しいコントリビューターやベテランのコントリビューターの参入障壁を低くします。

  • 貢献者向け: 問題の報告からプルリクエストの提出まで、貢献に関する明確な指示を提供します。

  • メンテナ向け: 期待値を設定し、プロセスを標準化することで、コントリビューションを合理化し、一般的な質問を明確にしたり、不完全な問題やプルリクエストの処理に費やす時間を短縮します。

よく書かれた CONTRIBUTING.md ファイルをプロジェクトに含めることは、新しい貢献者やベテランの貢献者をより歓迎し、オープンにする方法の1つです。また、関係者全員にとって、よりスムーズなワークフローを構築するのにも役立ちます。

歓迎しましょう#

歓迎されるガイドにします。あらゆる経験レベルの貢献の参加を促すために、わかりやすい言葉を使います。 例えば:

  • 専門用語は避け、必要な場合は用語を説明します (例えば "リポジトリをフォークする" など) 。

  • "ご協力ありがとうございます！ あなたとのコラボレーションを楽しみにしています。" のような友好的な自己紹介を入れます。

  • どんな些細な貢献でも評価されることを強調します。

CONTRIBUTING.md ファイルが含むべき内容#

貢献ファイルの例

あなたのPythonパッケージは、リポジトリのルートに README.md ファイル の次に CONTRIBUTING.md というファイルを含むべきです。

CONTRIBUTING.mdファイルには、以下の情報を含める必要があります:

  • 歓迎する貢献の種類

例: あらゆる種類の貢献を歓迎します。 既存の問題に取り組みたい場合は、このリポジトリにある私たちの問題をチェックし、手伝いたい問題にコメントしてください。そうでない場合は、新しいissueを開くことができます...

  • どのように貢献してほしいか。貢献のプロセスを明確に示します。 例えば:

    • 貢献者は未解決の問題に取り組むべきです

    • 新しいissueは歓迎されますか？

    • 貢献者は直接プルリクエスト(PR)を開くべきですか、それともまず変更について議論すべきですか？

  • フォークとプルリクエストのワークフローに関する説明と、 (利用可能な場合は) これらのステップを説明するリソースやガイドへのリンクを含めてください。

  • 課題、プルリクエスト、質問を提出するユーザーに対して設けているガイドライン。

development guide を持っているなら、リンクしてください。 このガイドでは、開発環境をローカルにセットアップする方法をわかりやすく説明します。また、貢献のプロセスを簡素化できるようなCIツールについても概説する必要があります (例えば commit.ci bot など), linters, code formatters, など。

このガイドには、質問することに興味がある人のための情報も含まれているはずです。 GitHubやGitLabのissueとして質問を受け付けるプロジェクトもあります。また、GitHubディスカッションやDiscourse、あるいはDiscordサーバーを使う人もいます。

貢献ファイルには以下も含めるべきです:

概要#

よく練られたCONTRIBUTING.mdファイルは、あなたのプロジェクトのウェルカムマットです！明確な指示、有用なリソース、歓迎ムードを提供することで、貢献者がプロジェクトに参加しやすくなり、より強力で協力的なコミュニティが構築されます。