Richtlinien für Repository-Mitarbeiter festlegen

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

In diesem Artikel

Informationen zu Beitragsrichtlinien

Um deine Projektmitarbeiter bei ihrer Arbeit zu unterstützen, kannst du dem Stammverzeichnis, dem Verzeichnis docs oder dem Verzeichnis .github deines Projektrepositorys ein Dokument 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. Der Link zu den Beitragsrichtlinien wird auch auf der Seite contribute deines Repositorys angezeigt. Ein Beispiel für eine contribute-Seite findest du unter github/docs/contribute.

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.

Sie können Standardbeitragsrichtlinien für Ihre Organisation oder Ihr persönliches Konto erstellen. Weitere Informationen findest du unter Erstellen einer Standard-Community-Health-File.

Tip

Repositorybetreuer können spezifische Richtlinien für Issues festlegen, indem sie eine Issue- oder Pull-Request-Vorlage für das Repository erstellen. Weitere Informationen findest du unter Informationen zu Vorlagen für Issues und Pull Requests.

Hinzufügen einer Datei CONTRIBUTING

  1. Navigieren Sie auf GitHub zur Hauptseite des Repositorys.

  2. Wähle über der Dateiliste das Dropdownmenü Datei hinzufügen aus, und klicke dann auf Neue Datei erstellen.

    Alternativ kannst du in der Dateistrukturansicht links auf klicken.

    Screenshot der Hauptseite eines Repositorys. Oberhalb der Dateiliste ist eine Schaltfläche mit der Bezeichnung „Datei hinzufügen“ dunkelorange umrandet. In der Dateistrukturansicht des Repositorys ist eine Schaltfläche mit einem Pluszeichensymbol ebenfalls dunkelorange hervorgehoben.

  3. Entscheide, ob deine 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. Bei Dateinamen für Beitragsrichtlinien wird die Groß-/Kleinschreibung nicht berücksichtigt. Dateien werden im Rich-Text-Format gerendert, wenn die Dateierweiterung einem unterstützten Format entspricht. Weitere Informationen findest du unter Working with non-code files (Arbeiten mit anderen Dateien als Codedateien).

    • Um deine Beitragsrichtlinien im Stammverzeichnis deines Repositorys sichtbar zu machen, gib CONTRIBUTING ein.
    • Um deine Beitragsrichtlinien im Verzeichnis docs deines Repositorys sichtbar zu machen, gib docs/ ein, um das neue Verzeichnis zu erstellen, um gibt dann_CONTRIBUTING_ ein.
    • Enthält ein Repository mehrere CONTRIBUTING-Dateien, wird die in Links angezeigte Datei in der folgenden Reihenfolge aus den Speicherorten ausgewählt: Zuerst wird das .github-Verzeichnis, dann das Stammverzeichnis des Repositorys und schließlich das docs-Verzeichnis berücksichtigt.

  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. Klicke auf Änderungen committen... .

  6. Gib im Feld „Commitnachricht“ eine kurze, aussagekräftige Commitnachricht ein, die die Änderung beschreibt, die Du an der Datei vorgenommen hast. Du kannst den Commit in der Commit-Mitteilung mehr als einem Autor zuordnen. Weitere Informationen findest du unter Einen Commit mit mehreren Autoren erstellen.

  7. 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 als Standardbranch festgelegt ist, solltest du einen neuen Branch für deinen Commit und dann einen Pull Request erstellen. Weitere Informationen findest du unter Erstellen eines Pull Requests.

    Screenshot eines GitHub-Pull Requests mit einem Optionsfeld zum direkten Commit an den Mainbranch oder zum Erstellen eines neuen Branchs. Der neue Branch ist ausgewählt.

  8. Klicke auf Änderungen committen oder Änderungen vorschlagen.

Beispiele für Beitragsrichtlinien

Wenn Du nun nicht sicher bist, was Du hier festlegen sollst, findest Du nachfolgend einige gute Beispiele für Beitragsrichtlinien:

Weiterführende Themen