Was macht Mitwirkenden-Onboarding?
Neue Mitwirkende brauchen drei Dinge: einen Weg (CONTRIBUTING.md), eine Karte (Labels) und einen ersten Schritt (Good First Issues). Baue alle drei aus den echten Befehlen des Projekts.
Wann verwenden
- „Schreibe eine CONTRIBUTING.md“ / „Wie bekomme ich Mitwirkende?“
- Erstellen oder Bereinigen von GitHub-Labels
- Schreiben von Good-First-Issues oder Vorbereitung auf Hacktoberfest oder einen Launch
Wann nicht verwenden
- Governance-Dokumente für Stiftungen (GOVERNANCE.md, Chartas): außerhalb des Rahmens.
- Verhaltenskodex-Text: übernimm den Contributor Covenant unverändert; schreibe ihn nicht um.
Ablauf
1. CONTRIBUTING.md
- Finde die echten Befehle: Setup (
pip install -e ".[dev]",npm ci,composer install), Tests, Lint/Format, Build, Docs. Lese CI-Workflows; sie sind die Quelle der Wahrheit. - Kopiere die Vorlage und fülle jeden Platzhalter aus. Führe jeden Befehl, den du dokumentierst, selbst aus oder sage klar, welche du nicht ausführen konntest.
- Halte es scannbar: Möglichkeiten zur Mitarbeit (nach benötigter Zeit), Setup, Tests, Stil, Commit-Konvention, PR-Prozess, Fragenort. Verlinke CODE_OF_CONDUCT.md und SECURITY.md.
- Füge 5–10 konkrete Einstiegsaufgaben unter „Good First Issues“ hinzu oder verlinke das Label.
2. Labels
scripts/ ist relativ zum Verzeichnis dieses Skills. Das Skript ruft nie GitHub selbst auf.
python3 scripts/labels.py generate > labels.json # Standard-Set
python3 scripts/labels.py generate --area cli --area docs --prefixed > labels.json
python3 scripts/labels.py validate labels.json # Exit 1 bei Problemen
python3 scripts/labels.py commands labels.json --repo OWNER/NAME > apply-labels.sh
Zeige dem Benutzer apply-labels.sh und frage vor der Ausführung: Es erstellt oder aktualisiert
Labels auf GitHub (gh label create ... --force). Es löscht nie Labels. Wenn der Benutzer
alte Labels entfernen möchte, liste sie mit gh label list auf und bestätige jede Löschung einzeln.
Behalte die GitHub-Namen good first issue und help wanted unverändert: GitHub und
Drittanbieter-Seiten verwenden sie, um Anfängeraufgaben sichtbar zu machen.
3. Good First Issues
Schreibe Kandidaten-Issues mit dem Leitfaden um. Jedes benötigt: Kontext, die genauen zu bearbeitenden Dateien, Abnahmekriterien, eine Testanleitung und ein Angebot zur Hilfe. Frage vor dem Bearbeiten oder Labeln von Issues auf GitHub; biete den Text zuerst als Entwurf an.
Ausgabe
- CONTRIBUTING.md (neu oder aktualisiert) und eine Liste der verifizierten vs. nicht verifizierten Befehle.
labels.jsonundapply-labels.sh(nicht ausgeführt, außer der Benutzer hat zugestimmt).- Entwürfe für Good-First-Issues als Markdown, bereit zum Einfügen oder zum Erstellen mit
gh issue create --title ... --body-file ... --label "good first issue"nach Genehmigung.
Standard-Label-Set
| Gruppe | Labels |
|---|---|
| Typ | bug, enhancement, documentation, question, performance, refactor |
| Mitwirkende | good first issue, help wanted |
| Status | needs-triage, needs-repro, needs-info, confirmed, in-progress, blocked, stale |
| Priorität | priority: critical, priority: high, priority: low |
| Lösung | duplicate, invalid, wontfix |
| Abhängigkeiten | dependencies, security, breaking-change |
--prefixed wechselt zu Namen im Stil type: bug, status: needs triage. GitHub begrenzt
Label-Namen auf 50 Zeichen und Beschreibungen auf 100; validate prüft beides sowie
6-stellige Hex-Farben und case-insensitive Duplikate.