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-Integritätsdateien zu einem öffentlichen oder internen Repository hinzufügen, das als .github bezeichnet wird. Diese Standarddateien werden für jedes Konto-eigene Repository verwendet und angezeigt, das nicht über eine eigene Datei dieses Typs verfügt, in der folgenden Reihenfolge:
- Der Ordner
.github - Das Stammverzeichnis des Repositorys
- Der Ordner
docs
Wenn keine entsprechende Datei im aktuellen Repository gefunden wird, GitHub wird die Standarddatei aus dem .github Repository verwendet, und zwar nach der gleichen Rangfolge.
Hinweis
Das .github Repository muss öffentlich oder intern sein, damit die meisten Standard-Community-Gesundheitsdateien in der gesamten Organisation angewendet werden. Private .github Repositorys werden nicht unterstützt.
Problem- und Pullanforderungsvorlagen erfordern jedoch ein öffentliches .github Repository und werden nicht organisationsweit aus einem internen Repository angewendet.
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.
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 finden Sie unter Informationen zu Community-Profilen für öffentliche Repositorys.
Informationen zu Sicherheitsrichtlinien
Nachdem jemand eine Sicherheitslücke in Ihrem Projekt gemeldet hat, können Sie GitHub Security Advisories verwenden, um Informationen zur Sicherheitsanfälligkeit offenzulegen, zu korrigieren und zu veröffentlichen. Weitere Informationen zum Berichterstellungsprozess und zur Offenlegung von Sicherheitsrisiken finden GitHubSie unter Informationen zur koordinierten Offenlegung von Sicherheitsrisiken. Weitere Informationen zu Sicherheitshinweisen für Repositorys finden Sie unter Informationen zu Sicherheitsempfehlungen für Repositorys.
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 |
|---|---|
| CODE_OF_CONDUCT.md | Eine CODE_OF_CONDUCT-Datei definiert Standards für die Teilnahme an einer Community. Weitere Informationen finden Sie unter Einen Verhaltenskodex zu Deinem Projekt hinzufügen. |
| CONTRIBUTING.md | Eine CONTRIBUTING-Datei kommuniziert, wie Personen zu Ihrem Projekt beitragen sollten. Weitere Informationen finden Sie unter Richtlinien für Repository-Mitarbeiter festlegen. |
| 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. |
| FUNDING.yml | Eine FUNDING-Datei zeigt eine Sponsor-Schaltfläche in Ihrem Repository an, um die Sichtbarkeit der Finanzierungsoptionen für Ihr Open Source Projekt zu erhöhen. Weitere Informationen finden Sie unter Sponsorenschaltfläche in deinem Repository anzeigen. |
| GOVERNANCE.md | Eine GOVERNANCE-Datei informiert Personen darüber, wie Ihr Projekt gesteuert wird. Beispielsweise werden darin die Projektrollen und Entscheidungsfindungsprozesse erläutert. Weitere Informationen finden Sie unter Leadership and Governance – Open Source Guides. |
| 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 eine Problemvorlage eine Bezeichnung festlegt, muss diese Bezeichnung in Ihrem .github Repository und allen Repositorys erstellt werden, in denen die Vorlage verwendet wird. Organisationsweite Problem- und Vorlagen für Pull-Anfragen erfordern, dass das .github Repository öffentlich ist. |
| 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
-
Wähle in der rechten oberen Ecke einer beliebigen Seite , und klicke dann auf Neues Repository.
-
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.
 -
Gib im Feld „Repositoryname“ .github ein.
-
Gib optional im Feld „Beschreibung“ eine Beschreibung ein.
-
Stellen Sie sicher, dass der Repositorystatus auf "Öffentlich" oder "**** festgelegt ist. Ein Repository für Standarddateien kann nicht privat sein.
-
Setzen Sie README auf Ein.
-
Klicke auf Repository erstellen.
-
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_TEMPLATEbefinden. Alle anderen unterstützten Dateien können sich im Stammverzeichnis des Repositorys, im.github-Ordner oder imdocs-Ordner befinden. Weitere Informationen finden Sie unter Neue Dateien erstellen.
