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:

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

Sie können Ihrem Projekt einen Verhaltenskodex hinzufügen, indem Sie manuell einen benutzerdefinierten Verhaltenskodex erstellen. Wenn du Verhaltensregeln verwendest, die von einer anderen Person oder Organisation geschrieben wurden, musst du alle Zuordnungsrichtlinien aus der Quelle befolgen.

Sie können einen standardmäßigen Verhaltenskodex für Ihre Organisation oder persönliches Konto erstellen. Weitere Informationen finden Sie unter Erstellen einer Standard-Community-Health-File.

Einen Verhaltenskodex manuell hinzufügen

Sie können Ihrem Projekt manuell einen Verhaltenskodex hinzufügen.

  1. Navigieren Sie auf GitHub zur Hauptseite des Repositorys.

  2. Wähle über der Liste der Dateien das Dropdownmenü Add file aus, und klicke auf Create new file.

    Alternativ kannst du in der Dateistrukturansicht links auf klicken.

    Screenshot der Hauptseite eines Repositorys, auf dem das Symbol „Add file“ und das Pluszeichen, die beide oben beschrieben wurden, orange umrandet sind.

  3. Geben Sie im Feld "Dateiname" den Pfad und den Namen für die Datei ein. GitHub Sucht nach einem Verhaltenskodex im .github Verzeichnis, dann nach dem Stamm des Repositorys, dann nach dem docs Verzeichnis und verwendet die erste gefundene Datei.

    • Geben Sie github/CODE_OF_CONDUCT.md ein, um Ihren Verhaltenskodex zum Verzeichnis des Repositorys .github hinzuzufügen.
    • Geben Sie CODE_OF_CONDUCT.md ein, um Ihren Verhaltensregeln zum Stammverzeichnis des Repositorys hinzuzufügen.
    • Geben Sie "docs/CODE_OF_CONDUCT.md" ein, um Ihren Verhaltensregeln zum Verzeichnis des Repositorys docs hinzuzufügen.

  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 einem Commit in der Commit-Nachricht mehr als einen Autor zuweisen. Weitere Informationen finden Sie unter Erstellen eines Commits mit mehreren Autoren oder im Auftrag einer Organisation.

  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 der Standardbranch ist, solltest du auswählen, einen neuen Branch für deinen Commit zu erstellen und dann einen Pull Request zu erstellen. Weitere Informationen finden Sie 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 Zweig wurde ausgewählt.

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