Projektleitfäden

CONTRIBUTING.md-Vorlage für ein Open-Source-Repository

Eine CONTRIBUTING.md-Datei hilft dabei, aus „Ich möchte helfen“ ein nützliches Issue oder einen Pull Request zu machen. Erkläre den kleinsten unterstützten Beitrag und wie er überprüft wird. Anforderungen sollten den tatsächlichen Projektablauf widerspiegeln, keinen ambitionierten Prozess, dem niemand folgt.

GitHubStart-Redaktion · Aktualisiert

Kopiere die Beitragsvorlage und passe sie an

Ersetze die Platzhalter und überprüfe jeden Befehl und Link. Heiße Dokumentationskorrekturen und Fehlerberichte weiterhin willkommen, auch wenn jemand noch nicht bereit ist, den Anwendungscode zu ändern.

# Mitwirken

## Vor dem Start
Lies das README und prüfe vorhandene Issues.
Besprich bei großen Änderungen den Ansatz vor der Umsetzung.

## Lokale Einrichtung
[Erforderliche Laufzeitumgebung und geprüfte Einrichtungsbefehle]

## Einen Fehler melden
Nenne Version, Umgebung, Schritte, erwartetes und tatsächliches Ergebnis.
Entferne Geheimnisse und personenbezogene Daten aus Protokollen.

## Einen Pull Request einreichen
- Erkläre das Problem und die vorgeschlagene Änderung.
- Halte die Änderung fokussiert.
- Führe [die projektspezifischen Prüfungen] aus.
- Aktualisiere betroffene Dokumentation.

## Review
[Wer prüft, wie geantwortet wird und realistische Verfügbarkeit]

## Weitere Möglichkeiten zu helfen
[Dokumentation, Beispiele, Übersetzungen oder reproduzierbare Berichte]

Mache die Richtlinien leicht auffindbar

GitHub erkennt Beitragsrichtlinien im Hauptverzeichnis des Repositorys sowie in den Verzeichnissen docs oder .github. Verlinke die Datei auch im README, damit Leser der Projekteinführung den Ablauf sofort finden.

Prüfe den Weg von den tatsächlichen Einstiegspunkten für Beiträge im Repository. Wenn mehrere Richtliniendateien existieren, vereinheitliche widersprüchliche Anweisungen. Mitwirkende sollten nicht einen Einrichtungsbefehl im README und einen anderen, nicht unterstützten Befehl im Beitragsleitfaden finden.

Gestalte einen zugänglichen ersten Beitrag

Wähle eine kleine Aufgabe mit klarem Ergebnis, etwa ein Beispiel für eine unterstützte Laufzeitumgebung zu korrigieren. Erkläre, wie das Problem reproduziert wird, welches Verhalten sich ändern soll und wie der Abschluss geprüft wird. Bezeichne eine Aufgabe nicht als anfängerfreundlich, wenn sie undokumentiertes internes Wissen voraussetzt.

Gib ehrlich an, wann du Reviews durchführen kannst. Wenn du keine Antwortzeit zusagen kannst, erkläre stattdessen, wie Mitwirkende den Status prüfen können. Klare Grenzen verringern aufgegebene Arbeit und sind hilfreicher als das Versprechen, jeden Beitrag zusammenzuführen.

Häufige Fragen

Ersetzt CONTRIBUTING.md die README.md?

Nein. Das README erklärt das Projekt und seine Nutzung. Beitragsrichtlinien erklären, wie Änderungen vorgeschlagen und überprüft werden.

Sollte ich die Testbefehle eines anderen Projekts kopieren?

Nur wenn sie auch für dein Projekt korrekt sind. Ersetze Platzhalter durch Befehle, die du tatsächlich geprüft hast.

Garantieren Beitragsrichtlinien mehr Mitwirkende?

Nein. Sie reduzieren Unsicherheit für Interessierte, aber der Nutzen des Projekts, die Aufgabenqualität und die Betreuung durch Maintainer bleiben wichtig.

Quellen