Richtlinien für Repository-Mitarbeiter festlegen

Um die Beiträge Ihrer Projektmitarbeiter zu konzertieren, können Sie dem Stammverzeichnis .github Ihres Projektrepositorys oder dem Unterverzeichnis docs eine Datei mit Beitragsrichtlinien 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 und sinnvolle Issues einzureichen.

Sowohl Inhabern als auch Mitarbeitern sparen Beitragsrichtlinien Zeit und Mühen, die durch fehlerhaft formulierte Pull Requests oder Issues entstehen, weil sie abgelehnt und erneut eingereicht werden müssen.

You can create default contribution guidelines for your organization. For more information, see "Creating a default community health file."

CONTRIBUTING-Datei hinzufügen

1. Navigiere in GitHub Enterprise zur Hauptseite des Repository.
2. Klicke oberhalb der Dateiliste auf Create new file (neue Datei erstellen).
   
3. Entscheiden Sie, ob die Beitragsrichtlinien im Unterverzeichnis docs oder direkt im Stammverzeichnis .github Ihres Repositorys gespeichert werden sollen. Geben Sie 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 Ihre Beitragsrichtlinien im Stammverzeichnis Ihres Repositorys erscheinen sollen, geben Sie CONTRIBUTING ein.
   • Wenn Ihre Beitragsrichtlinien im Unterverzeichnis docs Ihres Repositorys erscheinen sollen, geben Sie zur Erstellung des neuen Verzeichnisses docs/ und anschließend CONTRIBUTING ein.
4. Fügen Sie der neuen Datei Beitragsrichtlinien hinzu. Zum Beispiel
   • Schritte zur Erstellung korrekt formulierter Issues oder Pull Requests,
   • Links zu externer Dokumentation, zu Verteilerlisten oder zu einem Verhaltenskodex.
   • Erwartungen der Community und Verhaltensregeln
5. 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"
   
6. Lege unter den Commit-Mitteilungsfeldern fest, ob Du Dein Commit zum aktuellen Branch oder zu einem neuen Branch hinzufügen möchten. Wenn Dein aktueller Branch Master ist, solltest Du einen neuen Branch für Deinen Commit erstellen und dann einen Pull-Request erstellen. Weitere Informationen findest Du unter „Erstellen eines neuen Pull-Requests."
   
7. 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 (transparente Regierung)

Weiterführende Informationen

• Abschnitt „Starting an Open Source Project“ (Open-Source-Projekt starten) der Open-Source-Leitfäden
• „Lizenz zu einem Repository hinzufügen“