Ein Verhaltenskodex definiert die Standards für die Interaktion in einer Community. 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 ein Verhaltenskodex Standards und Erwartungen für die Interaktion in einer Community festlegt, findest Du in den Open-Source-Leitfäden.
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.
You can add a code of conduct to your project by using a template or manually creating a custom code of conduct. Your code of conduct will be available either way, but "Code of conduct" will only be marked as complete in your repository's community profile if you use a template. If you use a code of conduct written by another person or organization, be sure to follow any attribution guidelines from the source. For more information about community profiles, see "About community profiles for public repositories."
Du kannst einen Standard-Verhaltenskodex für Deine Organisation oder Dein Benutzerkonto erstellen. Weitere Informationen findest Du unter „Eine Standard Community-Unterstützungsdatei erstellen."
Einen Verhaltenskodex über eine Vorlage hinzufügen
GitHub bietet Vorlagen für gängige Verhaltenskodizes. So können Sie rasch einen Verhaltenskodex zu Ihrem Projekt hinzufügen.
-
Navigiere in GitHub zur Hauptseite des Repository.
-
Above the list of files, using the Add file drop-down, click Create new file.
-
Gib in das Feld für den Dateinamen CODE_OF_CONDUCT.md ein.
-
Klicke auf Choose a code of conduct template (Eine Vorlage für den Verhaltenskodex auswählen).
-
Wähle auf der linken Seite einen Verhaltenskodex aus, um eine Vorschau anzuzeigen und den Kodex zu Deinem Projekt hinzuzufügen.
-
Fülle die Felder auf der rechten Seite aus, um die richtigen Informationen in den ausgewählten Verhaltenskodex einzufügen.
-
Klicke auf Review and submit (Überprüfen und absenden).
-
Überprüfe den Inhalt des Verhaltenskodex, der sich im Textbereich befindet.
-
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"
-
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."
-
Klicke auf Propose new file (Neue Datei vorschlagen)
Einen Verhaltenskodex manuell hinzufügen
If the code of conduct you want to use isn't available in the provided templates, you can manually add a code of conduct.
-
Navigiere in GitHub zur Hauptseite des Repository.
-
Above the list of files, using the Add file drop-down, click Create new file.
-
In the file name field, type the name and extension for the file.
- To make your code of conduct visible in the repository's root directory, type CODE_OF_CONDUCT in the file name field.
- To make your code of conduct visible in the repository's
docs
directory, type docs/CODE_OF_CONDUCT. - To make your code of conduct visible in the repository's
.github
directory, type .github/CODE_OF_CONDUCT.
-
In the new file, add your custom code of conduct.
-
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"
-
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."
-
Klicke auf Propose new file (Neue Datei vorschlagen)