Um die Beiträge Deiner Projektmitarbeiter zu optimieren, kannst Du ein Dokument mit Beitragsrichtlinien in das Stammverzeichnis, in das Verzeichnis docs
oder in das Verzeichnis .github
Deines Projekt-Repositorys hinzufügen. Bei der Eröffnung eines Pull-Requests oder der Erstellung eines Issues wird dem betreffenden Mitarbeiter dann ein Link zu dieser Datei angezeigt.
Für den Repositoryinhaber stellen Beitragsrichtlinien eine Möglichkeit dar, Mitarbeitern die Regeln für Beiträge zu kommunizieren.
Mitarbeitern helfen die Richtlinien, korrekt formulierte Pull Requests einzureichen und sinnvolle Issues zu eröffnen.
Sowohl Inhaber als auch Mitarbeiter sparen dank Beitragsrichtlinien Zeit und Mühen, die durch fehlerhaft formulierte Pull Requests oder Issues entstehen, die abgelehnt und erneut eingereicht werden müssen.
You can create default contribution guidelines for your organization or user account. Weitere Informationen findest Du unter „Eine Standard Community-Unterstützungsdatei erstellen."
Tipp: Repository-Betreuer können mit Vorlagen für Issues oder Pull Requests spezifische Richtlinien für ihr Repository einrichten. Weitere Informationen findest Du unter „Informationen zu Vorlagen für Issues und Pull Requests“
CONTRIBUTING-Datei hinzufügen
-
Navigiere in GitHub Enterprise Server zur Hauptseite des Repository.
-
Above the list of files, click Create new file.
-
Entscheide, ob die Beitragsrichtlinien im Stammverzeichnis, im Verzeichnis
docs
oder im Verzeichnis.github
Deines Repositorys gespeichert werden sollen. Gib danach im Feld „Filename“ (Dateiname) den Namen und die Erweiterung der Datei ein. In Dateinamen von Beitragsrichtlinien wird die Groß-/Kleinschreibung ignoriert, und die Dateien können die Erweiterung .md oder .txt haben.- Wenn Deine Beitragsrichtlinien im Stammverzeichnis Deines Repositorys erscheinen sollen, gib CONTRIBUTING ein.
- Wenn Deine Beitragsrichtlinien im Verzeichnis
docs
Deines Repositorys erscheinen sollen, gib zur Erstellung des neuen Verzeichnisses docs/ ein und anschließend CONTRIBUTING.
-
Füge der neuen Datei Beitragsrichtlinien hinzu. Diese könnten beinhalten:
- Schritte zur Erstellung korrekt formulierter Issues oder Pull Requests.
- Links zu externer Dokumentation, zu Verteilerlisten oder zu einem Verhaltenskodex.
- Erwartungen der Community und Verhaltensregeln
-
Am Ende der Seite schreibe eine kurze, aussagekräftige Commit-Mitteilung, welche die Änderung beschreibt, welche Du an der Datei vornimmst. Du kannst den Commit in der Commit-Mitteilung mehr als einem Autor zuordnen. Weitere Informationen findest Du unter "Erstellen eines Commit mit mehreren Co-Autoren"
-
Lege unter den Commit-Mitteilungsfeldern fest, ob Du Deinen Commit zum aktuellen Branch oder zu einem neuen Branch hinzufügen möchtest. If your current branch is the default branch, you should choose to create a new branch for your commit and then create a pull request. Weitere Informationen findest Du unter „Erstellen eines neuen Pull Requests."
-
Klicke auf Propose new file (Neue Datei vorschlagen)
Beispiele für Beitragsrichtlinien
Wenn Sie nun nicht wissen, was Sie hier festlegen sollen, finden Sie nachfolgend einige gute Beispiele für Beitragsrichtlinien:
- Beitragsrichtlinien für den Editor Atom
- Beitragsrichtlinien für Ruby on Rails
- Beitragsrichtlinien des Open Government.
Weiterführende Informationen
- The Open Source Guides' section "Starting an Open Source Project"
- "Adding a license to a repository"