Erstellen einer Standard-Community-Health-File

Du kannst standardmäßige Community-Unterstützungsdateien wie z. B. CONTRIBUTING oder CODE_OF_CONDUCT erstellen. Standarddateien werden für alle Repositorys eines Kontos verwendet, das keine eigene Datei dieser Art enthält.

In diesem Artikel

Informationen zu Standard-Community-Unterstützungsdateien

Standardmäßige Communityintegritätsdateien sind eine Reihe vordefinierter Dateien, die Anleitungen und Vorlagen für ein fehlerfreies und kollaboratives Open Source-Projekt enthalten. Diese Dateien helfen dabei, verschiedene Aspekte der Entwicklungs- und Communityinteraktion deines Projekts zu automatisieren und zu standardisieren, was Transparenz, bewährte Methoden und Zusammenarbeit fördert.

Du kannst Community-Health-Standarddateien zu einem öffentlichen Repository hinzufügen, das .github heißt. GitHub Enterprise Server verwendet diese Standarddateien dann und zeigt sie für jedes Repository an, das im Besitz des Kontos ist, das nicht über eine eigene Datei dieses Typs verfügt. Dabei gilt die folgende Reihenfolge:

  • Der Ordner .github
  • Das Stammverzeichnis des Repositorys
  • Der Ordner docs

Wenn keine entsprechende Datei im aktuellen Repository gefunden wird, verwendet GitHub Enterprise Server die Standarddatei aus dem .github-Repository, wobei die gleiche Rangfolge befolgt wird.

Wenn z. B. jemand ein Issue oder einen Pull Request in einem Repository erstellt, das keine eigene CONTRIBUTING.md-Datei enthält, wird ein Link zur CONTRIBUTING.md-Standarddatei aus dem .github-Repository angezeigt. Wenn ein Repository jedoch Dateien in einem eigenen .github/ISSUE_TEMPLATE-Ordner hat, z. B. Issuevorlagen oder eine _config.yml-Datei, wird keiner der Inhalte des Standardordners .github/ISSUE_TEMPLATE verwendet. Auf diese Weise können Repositoryverwalter die Standarddateien mit bestimmten Vorlagen oder Inhalten pro Repository außer Kraft setzen.

Das Speichern der Dateien im .github-Repository ermöglicht das Vornehmen von Änderungen an den Standardeinstellungen an einer zentralen Stelle. Darüber hinaus werden sie nicht im Dateibrowser oder Git-Verlauf der einzelnen Repositorys angezeigt und sind nicht in Klonen, Paketen oder Downloads enthalten.

Unterstützte Dateitypen

Sie können in Ihrer Organisation oder in Ihrem persönlichen Konto Standardeinstellungen für die folgenden Integritätsdateien der Community erstellen:

CommunityintegritätsdateiBeschreibung
CONTRIBUTING.mdEine CONTRIBUTING-Datei kommuniziert, wie Personen zu Ihrem Projekt beitragen sollten. Weitere Informationen finden Sie unter Richtlinien für Repository-Mitarbeiter festlegen.
DiskussionskategorieformulareDiskussionskategorieformulare passen die Vorlagen an, die den Mitgliedern der Gemeinschaft zur Verfügung stehen, wenn sie neue Diskussionen in Ihrem Repository eröffnen. Weitere Informationen finden Sie unter Erstellen von Diskussionskategorieformularen.
GOVERNANCE.mdEine GOVERNANCE-Datei informiert Personen darüber, wie Ihr Projekt gesteuert wird. Beispielsweise werden darin die Projektrollen und Entscheidungsfindungsprozesse erläutert.
Issue- und Pull-Request-Vorlagen und config.ymlMit den Vorlagen für Issues und Pull Requests können Sie die Informationen anpassen und standardisieren, die die Mitwirkenden angeben sollen, wenn sie Issues und Pull Requests in Ihrem Repository erstellen. Weitere Informationen finden Sie unter Informationen zu Vorlagen für Issues und Pull Requests.
SECURITY.mdEine SECURITY-Datei enthält Anweisungen zum Melden von Sicherheitsrisiken in Ihrem Projekt und eine Beschreibung, die die Datei verlinkt. Weitere Informationen finden Sie unter Hinzufügen einer Sicherheitsrichtlinie für dein Repository.
SUPPORT.mdEine SUPPORT-Datei informiert Personen über Möglichkeiten, Hilfe zu Ihrem Projekt zu erhalten. Weitere Informationen finden Sie unter Hinzufügen von Supportressourcen zu deinem Projekt.

Du kannst keine Standard-Lizenzdatei erstellen. Lizenzdateien müssen zu individuellen Repositorys hinzugefügt werden, damit die Datei bei Klonen, Paketieren und Herunterladen des Projekts enthalten ist.

Ein Repository für Standarddateien erstellen

  1. Wähle in der rechten oberen Ecke einer beliebigen Seite , und klicke dann auf Neues Repository.

    Screenshot eines GitHub-Dropdownmenüs mit Optionen zum Erstellen neuer Elemente. Das Menüelement „Neues Repository“ ist in dunklem Orange eingerahmt.

  2. Wählen Sie über das Dropdownmenü Besitzer die Organisation oder das persönliche Konto aus, für die bzw. das Sie Standarddateien erstellen möchten.

    Screenshot des Besitzermenüs für ein neues GitHub-Repository. Das Menü zeigt zwei Optionen, octocat und github.

  3. Gib im Feld „Repositoryname“ .github ein.

  4. Gib optional im Feld „Beschreibung“ eine Beschreibung ein.

  5. Stelle sicher, dass der Repositorystatus auf Öffentlich festgelegt ist. Ein Repository für Standarddateien kann nicht privat sein.

  6. Aktivieren Sie das Kontrollkästchen Initialize this repository with a README (Dieses Repository mit einer README-Datei initialisieren).

  7. Klicke auf Repository erstellen.

  8. Erstelle im Repository eine der möglichen Community-Unterstützungsdateien. Issuevorlagen und die zugehörige Konfigurationsdatei müssen sich in einem Ordner namens .github/ISSUE_TEMPLATE befinden. Alle anderen unterstützten Dateien können sich im Stammverzeichnis des Repositorys, im .github-Ordner oder im docs-Ordner befinden. Weitere Informationen finden Sie unter Neue Dateien erstellen.