Richtlinien für Repository-Mitarbeiter festlegen

Du kannst Richtlinien erstellen, wie Personen zu Deinem Projekt beitragen sollten.

About contributing guidelines

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. The link to the contributing guidelines also appears on your repository's contribute page. For an example of a contribute page, see github/docs/contribute.

Beitragsrichtlinien

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.

Du kannst Standard-Beitragsrichtlinien für Deine Organisation oder Dein Benutzerkonto erstellen. 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

  1. Navigiere in GitHub Enterprise Server zur Hauptseite des Repository.
  2. Above the list of files, using the Add file drop-down, click Create new file. "Create new file" in the "Add file" dropdown
  3. 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. Contributing guidelines filenames are not case sensitive. Files are rendered in rich text format if the file extension is in a supported format. For more information, see "Working with non-code files." Neuer Dateiname
    • 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.
    • If a repository contains more than one CONTRIBUTING file, then the file shown in links is chosen from locations in the following order: the .github directory, then the repository's root directory, and finally the docs directory.
  4. 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
  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" Commit-Mitteilung für Deine Änderung
  6. 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." Branch-Optionen für Commit
  7. Klicke auf Propose new file (Neue Datei vorschlagen) Schaltfläche "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:

Weiterführende Informationen

Did this doc help you?

Privacy policy

Help us make these docs great!

All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.

Make a contribution

Oder, learn how to contribute.