コントリビューターオンボーディング は何をしますか?
新しいコントリビューターには3つのものが必要です:道(CONTRIBUTING.md)、地図(ラベル)、そして最初の一歩(good first issues)。これらすべてをプロジェクトの実際のコマンドから構築します。
使用するタイミング
- 「CONTRIBUTING.mdを書いて」/「どうやってコントリビューターを増やすの?」
- GitHubラベルの作成や整理
- Good first issuesの作成、またはHacktoberfestやリリースの準備
使用しないタイミング
- 財団向けのガバナンス文書(GOVERNANCE.md、憲章など):対象外です。
- 行動規範のテキスト:Contributor Covenantをそのまま採用し、書き直さないでください。
ワークフロー
1. CONTRIBUTING.md
- 実際のコマンドを見つけます:セットアップ(
pip install -e ".[dev]"、npm ci、composer install)、テスト、lint/format、ビルド、ドキュメント。CIワークフローを読んでください。それが真実の情報源です。 - テンプレートをコピーし、すべてのプレースホルダーを埋めてください。文書化した各コマンドを実際に実行するか、実行できなかったコマンドを明確に記載してください。
- スキャンしやすく保ちます:貢献方法(必要な時間別)、セットアップ、テスト、スタイル、コミット規約、PRプロセス、質問場所。CODE_OF_CONDUCT.mdとSECURITY.mdへのリンクを追加します。
- 「Good first issues」の下に5~10個の具体的なスタータータスクを追加するか、ラベルへのリンクを貼ります。
2. ラベル
scripts/ はこのスキルのディレクトリからの相対パスです。スクリプトはGitHub自体を呼び出しません。
python3 scripts/labels.py generate > labels.json # デフォルトセット
python3 scripts/labels.py generate --area cli --area docs --prefixed > labels.json
python3 scripts/labels.py validate labels.json # 問題があれば終了コード1
python3 scripts/labels.py commands labels.json --repo OWNER/NAME > apply-labels.sh
ユーザーに apply-labels.sh を表示し、実行前に確認を取ります。このスクリプトはGitHub上でラベルを作成または更新します(gh label create ... --force)。ラベルを削除することはありません。古いラベルを削除したい場合は、gh label list で一覧を表示し、各削除を確認してください。
GitHubの名称 good first issue と help wanted は変更しないでください。GitHubやサードパーティサイトが初心者向けタスクを表示するために使用しています。
3. Good first issues
候補となるIssueをガイドに従って書き換えます。それぞれに必要なもの:コンテキスト、触れるべき正確なファイル、受け入れ基準、テスト方法、サポート提供の申し出。GitHub上でIssueを編集またはラベル付けする前に確認を取り、まずはドラフトとしてテキストを提供してください。
出力
- CONTRIBUTING.md(新規または更新)と、検証済み/未検証のコマンド一覧。
labels.jsonとapply-labels.sh(ユーザーが承認しない限り実行しません)。- Good first issuesのドラフト(Markdown形式)。そのまま貼り付けるか、承認後に
gh issue create --title ... --body-file ... --label "good first issue"で作成できます。
デフォルトラベルセット
| グループ | ラベル |
|---|---|
| type | bug, enhancement, documentation, question, performance, refactor |
| contributor | good first issue, help wanted |
| status | needs-triage, needs-repro, needs-info, confirmed, in-progress, blocked, stale |
| priority | priority: critical, priority: high, priority: low |
| resolution | duplicate, invalid, wontfix |
| dependencies | dependencies, security, breaking-change |
--prefixed を指定すると type: bug、status: needs triage のようなスタイル名に切り替わります。GitHubはラベル名を50文字、説明を100文字に制限しています。validate はこれらに加えて、6桁の16進色と大文字小文字を区別しない重複をチェックします。