Skip to main content

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.

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 Communityprofilen 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-Communityintegritätsdatei.

Einen Verhaltenskodex über eine Vorlage hinzufügen

GitHub Enterprise Cloud 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. 1. Klicke oberhalb der Dateiliste im Dropdownmenü Datei hinzufügen auf Neue Datei erstellen. „Neue Datei erstellen“ im Dropdownmenü „Datei hinzufügen“
  2. Gib im Feld für den Dateinamen CODE_OF_CONDUCT.md ein.
  3. Klicke auf Vorlage für Verhaltensregeln auswählen. Schaltfläche zum Auswählen einer Vorlage für Verhaltensregeln
  4. Wähle auf der linken Seite einen Verhaltenskodex aus, um eine Vorschau anzuzeigen und den Kodex zu Deinem Projekt hinzuzufügen. Auswahl einer Vorlage für Verhaltensregeln
  5. Fülle die Felder auf der rechten Seite aus, um die richtigen Informationen in den ausgewählten Verhaltenskodex einzufügen.
  6. Klicke auf Überprüfen und einreichen. Verhaltensregeln überprüfen und an das Projekt übermitteln
  7. Überprüfe den Inhalt des Verhaltenskodex, der sich im Textbereich befindet.
  8. 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 Commits mit mehreren Co-Autoren. Commit-Mitteilung für Ihre Änderung 1. 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 neuen Pull Requests. Commitbranchoptionen 1. Klicke auf Neue Datei vorschlagen. Schaltfläche „Neue Datei 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. 1. Klicke oberhalb der Dateiliste im Dropdownmenü Datei hinzufügen auf Neue Datei erstellen. „Neue Datei erstellen“ im Dropdownmenü „Datei hinzufügen“
  2. Gib im Feld für den Dateinamen den Namen und die Erweiterung für die Datei ein. Neuer Dateiname für Verhaltensregeln
    • 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.
  3. Füge der neuen Datei deine benutzerdefinierten Verhaltensregeln hinzu.
  4. 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 Commits mit mehreren Co-Autoren. Commit-Mitteilung für Ihre Änderung 1. 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 neuen Pull Requests. Commitbranchoptionen 1. Klicke auf Neue Datei vorschlagen. Schaltfläche „Neue Datei vorschlagen“