Richtlinien für Repository-Mitarbeiter festlegen

Inhalt dieses Artikels

• CONTRIBUTING-Datei hinzufügen
• Beispiele für Beitragsrichtlinien
• Weiterführende Informationen

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.

CONTRIBUTING-Datei hinzufügen

1. Navigieren Sie in GitHub Enterprise zur Repository-Hauptseite.

2. Above the file list, click Create new file.

   

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. At the bottom of the page, type a short, meaningful commit message that describes the change you made to the file. You can attribute the commit to more than one author in the commit message. For more information, see "Creating a commit with multiple co-authors."

   

6. Legen Sie unter den Commit-Mitteilungsfeldern fest, ob Sie Ihr Commit zum aktuellen Branch oder zu einem neuen Branch hinzufügen möchten. If your current branch is master, you should choose to create a new branch for your commit and then create a pull request. For more information, see "Creating a new pull request."

   

7. Click Propose new file.

   

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“