Einen Verhaltenskodex zu Deinem Projekt hinzufügen

Mit einem Verhaltenskodex kannst du Standards für die Community festlegen, ein einladendes und integratives Projekt signalisieren, und die Verfahren für den Umgang mit Missbrauch aufzeigen.

In diesem Artikel

Verhaltensregeln legen die Standards für die Interaktion in einer Community fest. Er signalisiert, dass in dieser integrativen Umgebung alle Beiträge respektiert werden. Außerdem beschreibt er Verfahren für die Problembehandlung bei Schwierigkeiten zwischen Mitgliedern Deiner Projekt-Community. Weitere Informationen dazu, warum Verhaltensregeln Standards und Erwartungen für die Interaktion in einer Community festlegen, findest du im Open-Source-Leitfaden.

Bevor Du einen Verhaltenskodex für Dein Projekt einsetzt, solltest Du Folgendes tun:

  • Untersuche verschiedene Verhaltenskodizes, die für Open-Source-Projekte erstellt wurden. Wähle einen Kodex aus, der den Standards Deiner Community entspricht.
  • Überlege Dir eingehend, ob Du diesen Kodex durchsetzen willst und kannst.

Du kannst deinem Projekt benutzerdefinierte Verhaltensregeln hinzufügen, die du mithilfe einer Vorlage oder manuell erstellst. Deine Verhaltensregeln sind in beiden Fällen verfügbar, aber der Eintrag „Verhaltensregeln“ wird im Communityprofil deines Repositorys nur dann als abgeschlossen gekennzeichnet, wenn du eine Vorlage verwendest. Wenn du Verhaltensregeln verwendest, die von einer anderen Person oder Organisation geschrieben wurden, musst du alle Zuordnungsrichtlinien aus der Quelle befolgen. Weitere Informationen zu Communityprofilen findest du unter Informationen zu Community-Profilen für öffentliche Repositorys.

Du kannst Standardverhaltensregeln für deine Organisation oder dein persönliches Konto erstellen. Weitere Informationen findest du unter Erstellen einer Standard-Community-Health-File.

Einen Verhaltenskodex über eine Vorlage hinzufügen

GitHub bietet Vorlagen für gängige Verhaltenskodizes. So kannst du rasch einen Verhaltenskodex zu deinem Projekt hinzufügen.

  1. Navigiere auf GitHub.com 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. Gib im Feld für den Dateinamen CODE_OF_CONDUCT.md ein.

  4. Wähle Vorlage für Verhaltensregeln auswählen aus

    Screenshot eines GitHub-Repositorys mit einer neuen Markdowndatei, die erstellt wird. Eine Schaltfläche auf der rechten Seite mit der Bezeichnung „Vorlage für Verhaltensregeln auswählen“ ist dunkelorange umrandet.

  5. Wähle auf der linken Seite einen Verhaltenskodex aus, um eine Vorschau anzuzeigen und den Kodex zu Deinem Projekt hinzuzufügen.

  6. Fülle die Felder auf der rechten Seite aus, um die richtigen Informationen in den ausgewählten Verhaltenskodex einzufügen.

  7. Klicke auf Überprüfen und einreichen.

  8. Überprüfe den Inhalt des Verhaltenskodex, der sich im Textbereich befindet.

  9. Klicke auf Änderungen committen... .

  10. 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.

  11. 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.

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

Einen Verhaltenskodex manuell hinzufügen

Wenn die Verhaltensregeln, die du verwenden möchtest, in den bereitgestellten Vorlagen nicht verfügbar sind, kannst du Verhaltensregeln manuell hinzufügen.

  1. Navigiere auf GitHub.com 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. Gib im Feld für den Dateinamen den Namen und die Erweiterung für die Datei ein.

    • Um die Verhaltensregeln im Stammverzeichnis des Repositorys sichtbar zu machen, gib CODE_OF_CONDUCT im Feld für den Dateinamen ein.
    • Um die Verhaltensregeln im Verzeichnis docs des Repositorys sichtbar zu machen, gib docs/CODE_OF_CONDUCT ein.
    • Um die Verhaltensregeln im Verzeichnis .github des Repositorys sichtbar zu machen, gib .github/CODE_OF_CONDUCT ein.

  4. Füge der neuen Datei deine benutzerdefinierten Verhaltensregeln hinzu.

  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.