Skip to main content

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.

Informationen zu Standard-Community-Unterstützungsdateien

Du kannst standardmäßige Communityintegritätsdateien einem öffentlichen Repository namens .github im Stammverzeichnis des Repositorys oder in den Ordnern docs oder .github hinzufügen.

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:

  • im Root des Repositorys
  • im Ordner .github
  • im 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 in seinem 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 sind nicht in Klonen, Paketen oder Downloads von einzelnen Repositorys enthalten, da sie nur im .github-Repository gespeichert sind.

Unterstützte Dateitypen

Du kannst in deiner Organisation oder deinem persönlichen Konto Standardeinstellungen für die folgenden Communityintegritätsdateien erstellen:

Communityintegritätsdatei | Beschreibung --- | --- CODE_OF_CONDUCT.md | Eine A CODE_OF_CONDUCT-Datei definiert Standards für die Interaktion in einer Community. Weitere Informationen findest du unter „Hinzufügen eines Verhaltenskodexes zum Projekt“. CONTRIBUTING.md | Eine CONTRIBUTING-Datei vermittelt, wie Personen zu deinem Projekt beitragen sollten. Weitere Informationen findest du unter „Festlegen von Richtlinien für Repositorymitwirkende“. FUNDING.yml | Eine FUNDING-Datei zeigt eine Sponsorenschaltfläche in deinem Repository an, um die Transparenz von Finanzierungsoptionen für dein Open Source Projekt zu erhöhen. Weitere Informationen findest du unter „Anzeigen einer Sponsorenschaltfläche im Repository“. Issue- und Pull Request-Vorlagen und config.yml | Mit Issue- und Pull Request-Vorlagen kannst du die Informationen, die Mitarbeiter beim Erstellen von Issues und Pull Requests in deinem Repository verwenden sollen, anpassen und standardisieren. Weitere Informationen findest du unter „Informationen zu Issue- und Pull Request-Vorlagen“. SECURITY.md | Eine SECURITY-Datei enthält Anweisungen zum Melden eines Sicherheitsrisikos in deinem Projekt. Weitere Informationen findest du unter „Hinzufügen einer Sicherheitsrichtlinie zum Repository“. SUPPORT.md | Eine SUPPORT-Datei informiert Personen über Möglichkeiten, Hilfe zu deinem Projekt zu erhalten. Weitere Informationen findest du unter „Hinzufügen von Supportressourcen zum 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. Verwende in der oberen rechten Ecke einer beliebigen Seite das -Dropdownmenü, und wähle Neues Repository aus. Dropdownmenü mit der Option zum Erstellen eines neuen Repositorys
  2. Verwende das Dropdownmenü Besitzer, und wähle die Organisation oder das persönliche Konto aus, für die bzw. das du Standarddateien erstellen möchtest. Dropdownmenü „Besitzer“
  3. Gib .github als Namen für dein Repository und eine optionale Beschreibung ein. Feld „Repository erstellen“
  4. Stelle sicher, dass der Repositorystatus auf Öffentlich festgelegt ist (ein Repository für Standarddateien darf nicht privat sein). Optionsfelder zum Auswählen des privaten oder öffentlichen Status 1. Aktivieren Sie das Kontrollkästchen Initialize this repository with a README (Dieses Repository mit einer README-Datei initialisieren). Dieses Repository mit einer README-Datei initialisieren 1. Klicke auf Repository erstellen. Schaltfläche zum Erstellen eines Repositorys
  5. 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 Erstellen neuer Dateien.