初めてのコントリビューター向けCONTRIBUTING.md

初めてのオープンソースコントリビューターを歓迎するために特別に設計されたコントリビューションガイドラインを作成。good-first-issueラベル、メンタリング、ステップバイステップのgit手順を含みます。

Audience

詳細な説明

初めてのコントリビューターを歓迎する

オープンソースへの貢献に対する最大の障壁は技術スキルではなく、プロセスに対する不確実性です。初心者向けに設計されたガイドは、コントリビューターのパイプラインを劇的に増加させることができます。

ラベル戦略

GitHubラベルを使用してアプローチしやすさを示します:

  • good first issue -- 明確なスコープを持つシンプルで自己完結したタスク
  • help wanted -- メンテナーの時間が限られているissue
  • documentation -- 自信を築く低リスクな変更
  • beginner friendly -- コードベースの深い知識を必要としないタスク

ステップバイステップのGit手順

コントリビューターがgitに精通していると仮定しないでください。正確なコマンドを含めます:

# GitHubでリポジトリをforkしてから:
git clone https://github.com/YOUR_USERNAME/project.git
cd project
git checkout -b my-feature
# 変更を加えます...
git add .
git commit -m "feat: add my feature"
git push origin my-feature
# GitHubでプルリクエストを開きます

メンタリングセクション

明示的にヘルプを提供します:

ヘルプが必要ですか? 早い段階でドラフトPRを開き、説明にガイダンスを求めてください。メンテナーは初めてのコントリビューターを喜んでサポートします。

対処すべきよくある間違い

  • 作業を開始する前にupstreamと同期するのを忘れる
  • mainブランチに直接変更を加える
  • ローカルでテストを実行せずにPRを提出する
  • 重複を開く前に既存のissueを読まない

認識

初めてのコントリビューターを公にお礼します。All Contributorsバッジまたは README のContributorsセクションを追加します。認識はリピート貢献を促進します。

ユースケース

HacktoberfestやGoogle Summer of Codeに参加しているプロジェクトで、初めてのコントリビューターの流入が予想され、貢献プロセスをガイドする明確で忍耐強いドキュメントが必要な場合。

試してみる — CONTRIBUTING.md Generator

フルツールを開く