Erstellen einer Standard-Community-Health-File

Informationen zu Standard-Community-Unterstützungsdateien

Standardmäßige Community-Gesundheitsdateien sind eine Reihe vordefinierter Dateien, die Anleitungen und Vorlagen für die Aufrechterhaltung eines gesunden und kooperativen Open-Source-Projekts bereitstellen. Diese Dateien helfen dabei, verschiedene Aspekte der Entwicklungs- und Communityinteraktion Ihres Projekts zu automatisieren und zu standardisieren, was Transparenz, bewährte Methoden und Zusammenarbeit fördert.

Sie können standardmäßige Community-Zustandsdateien zu einem öffentlichen oder internen Repository mit dem Namen .github hinzufügen, und GitHub wird die Standarddateien für alle Repositorys verwenden und anzeigen, die sich im Besitz des Kontos befinden, das keine eigene Datei dieses Typs hat, in der folgenden Reihenfolge:

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

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

Wenn z. B. jemand einen Issue oder Pull Request in einem Repository erstellt, das keine eigene CONTRIBUTING.md -Datei enthält, wird ein Link zur standardmäßigen CONTRIBUTING.md-Datei vom .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 Durchführen 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.

Informationen zu Sicherheitsrichtlinien

Mit eindeutigen Anweisungen zur Sicherheitsberichterstellung erleichterst du deinen Benutzern, Sicherheitsrisiken, die sie in deinem Repository finden, über deinen bevorzugten Kommunikationskanal zu melden.

Ein Beispiel einer realen SECURITY.md-Datei finden Sie unter https://github.com/electron/electron/blob/main/SECURITY.md.

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ätsdatei	BESCHREIBUNG

          _CONTRIBUTING.md_ | Eine CONTRIBUTING-Datei kommuniziert, wie Personen zu Ihrem Projekt beitragen sollten. Weitere Informationen finden Sie unter [AUTOTITLE](/communities/setting-up-your-project-for-healthy-contributions/setting-guidelines-for-repository-contributors). |

| Diskussionskategorieformulare | Diskussionskategorieformulare 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.md | Eine 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.yml | Mit 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.

Wenn mit einer Issuevorlage eine Bezeichnung festlegt wird, muss diese Bezeichnung in Ihrem .github-Repository und allen Repositorys erstellt werden, in denen die Vorlage verwendet wird. | | SECURITY.md | Eine 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.md | Eine 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.

   

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 Eigentümermenüs für ein neues GitHub-Repository. Das Menü zeigt zwei Optionen, octocat und github.](/assets/images/help/repository/create-repository-owner.png)
   

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

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

5. Stellen Sie sicher, dass der Repositorystatus auf Public oder Internalfestgelegt ist. Ein Repository für Standarddateien kann nicht privat sein.

6. Setzen Sie README auf Ein.

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.