Artikelversion: Enterprise Server 2.17
Eine Standard Community-Unterstützungsdatei erstellen
Du kannst Standard Community-Unterstützungsdateien wie zum Beispiel CONTRIBUTING oder CODE_OF_CONDUCT erstellen. Standarddateien werden für alle öffentlichen Repositorys eines Kontos verwendet, das keine eigenen Dateien dieser Art enthält.
Informationen zu Standard Community-Unterstützungsdateien
Du kannst Standard Community-Unterstützungsdateien dem Stammverzeichnis eines öffentlichen Repositorys mit Namen .github hinzufügen, welches einer Organisation gehört.
GitHub Enterprise wird Standarddateien für ein öffentliches Repository benutzen und anzeigen, sofern das Konto, dem das Repository gehört, über keine eigenen Dateien dieses Typs an den folgenden Stellen verfügt:
- im Root des Repositorys
- im Ordner
.github - im Ordner
docs
Wenn z. B. jemand einen Issue oder Pull Request in einem öffentlichen Repository erstellt, das keine eigene CONTRIBUTING-Datei enthält, wird ein Link zur standardmäßigen CONTRIBUTING-Datei angezeigt. Wenn ein Repository solche Dateien in seinem eigenen .github/ISSUE_TEMPLATE-Verzeichnis hat, werden keine Inhalte des Standard .github/ISSUE_TEMPLATE-Verzeichnisses 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 Standards in Deiner Organisation für die folgenden Community-Unterstützungsdateien erstellen:
| Community-Unterstützungsdatei | Beschreibung |
|---|---|
| CONTRIBUTING.md | Eine CONTRIBUTING-Datei erläutert, wie zu Deinem Projekt beigetragen werden soll. Weitere Informationen findest Du unter „Richtlinien für Repository-Mitarbeiter festlegen“. |
| Issue- und Pull-Request-Vorlagen | Mit den Vorlagen für Issues und Pull-Requests kannst Du die Informationen anpassen und standardisieren, die Mitarbeiter beim Öffnen von Issues und Pull-Requests in Deinem Repository berücksichtigen sollen. Weitere Informationen findest Du unter „Informationen zu Vorlagen für Issues und Pull-Requests“. |
| SUPPORT.md | Mit einer SUPPORT-Datei kannst Du anderen mitteilen, wie sie Unterstützung bei Deinem Projekt erhalten können. Weitere Informationen findest Du unter „Support-Ressourcen zu Deinem Projekt hinzufügen.“ |
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
- Benutze in der oberen rechten Ecke einer beliebigen Seite das -Dropdownmenü und wähle New Repository (Neues Repository).
- Benutze das Owner (Inhaber) Dropdownmenü und wähle die Organisation, für welche Du Standarddateien erstellen willst.
- Gib .github als Namen für Dein Repository sowie optional eine Beschreibung ein.
- Wähle, dass das Repository öffentlich sein soll.
- Wähle Initialize this repository with a README (Dieses Repository mit einer README-Datei initialisieren).
- Klicke auf Create repository (Repository erstellen).
- Erstelle im Repository eine der möglichen Community-Unterstützungsdateien. Issue-Vorlagen müssen sich in einem Verzeichnis namens
.github/ISSUE_TEMPLATEbefinden. Alle anderen unterstützten Dateien müssen sich im Root des Repositorys befinden. Weitere Informationen findest Du unter „Neue Dateien erstellen.“