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. Du kannst standardmäßige Communityintegritätsdateien einem öffentlichen Repository namens .github im Stammverzeichnis des Repositorys oder in den Ordnern docs oder .github hinzufügen. Mithilfe dieser Dateien können verschiedene Aspekte der Entwicklungs- und Community-Interaktion des Projekts automatisiert und standardisiert werden. Sie sind von wesentlicher Bedeutung für die Förderung von Transparenz, bewährten Praktiken und Zusammenarbeit in Open Source-Projekten.

Standarddateien werden von GitHub für beliebige im Besitz des Kontos befindliche Repositorys verwendet und angezeigt, die an keiner der folgenden Stellen über eigene Dateien dieses Typs verfügen:

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

Wenn z. B. jemand einen Issue oder Pull Request in einem Repository erstellt, das keine eigene CONTRIBUTING-Datei enthält, wird ein Link zur standardmäßigen CONTRIBUTING-Datei angezeigt. Wenn ein Repository Dateien im eigenen .github/ISSUE_TEMPLATE-Ordner enthält, einschließlich Issuevorlagen oder einer config.yml-Datei, wird keiner der Inhalte des standardmäßigen .github/ISSUE_TEMPLATE-Ordners verwendet.

Standarddateien werden nicht im Dateibrowser oder im Git-Verlauf angezeigt und sind nicht in Klonen, Paketen oder Downloads einzelner .github-Repositorys enthalten, da sie nur im Repository gespeichert sind.

Als Repositoryverwalter*in kannst du die Checkliste für Communitystandards verwenden, um zu ermitteln, ob dein Projekt den empfohlenen Communitystandards entspricht, damit andere Personen dein Projekt nutzen und zu diesem beitragen können. Weitere Informationen findest du unter Informationen zu Community-Profilen für öffentliche Repositorys.

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
CODE_OF_CONDUCT.mdEine CODE_OF_CONDUCT-Datei definiert Standards für die Teilnahme an einer Community. Weitere Informationen findest du unter Einen Verhaltenskodex zu Deinem Projekt hinzufügen.
CONTRIBUTING.mdEine CONTRIBUTING-Datei kommuniziert, wie Personen zu Ihrem Projekt beitragen sollten. Weitere Informationen findest du 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 findest du unter Erstellen von Diskussionskategorieformularen.
FUNDING.ymlEine FUNDING-Datei zeigt eine Sponsoring-Schaltfläche in Ihrem Repository an, um die Sichtbarkeit der Finanzierungsoptionen für Ihr Open Source-Projekt zu erhöhen. Weitere Informationen findest du unter Sponsorenschaltfläche in deinem Repository anzeigen.
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 findest du 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 findest du 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 findest du 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 findest du unter Neue Dateien erstellen.