Die GitHub-Dokumentation ist Open Source. Jeder kann zur Dokumentation im öffentlichen docs-Repository beitragen: https://github.com/github/docs. GitHub-Mitarbeitende arbeiten an der Dokumentation in einer Kopie dieses Repositorys namens docs-internal. Die beiden Repositorys werden automatisch synchronisiert, damit sie beide auf dem neuesten Stand sind, wobei Änderungen in den main-Branch beider Repositorys zusammengeführt werden. Der Einfachheit halber verweisen wir in den Artikeln zum Mitwirken zu GitHub Docs auf das „Dokumentationsrepository“.
Das Dokumentationsrepository ist der Ort zum Diskutieren und Zusammenarbeiten an der Dokumentation, die hier auf docs.github.com veröffentlicht wird.
Probleme
Issues werden verwendet, um Aufgaben nachzuverfolgen, bei denen Mitwirkende helfen können. Wenn ein Issue eine triage-Bezeichnung hat, haben wir es noch nicht überprüft, deshalb solltest du noch nicht daran arbeiten.
Wenn du etwas im Dokumentationsinhalt oder über die docs.github.com-Website gefunden hast, das aktualisiert werden sollte, suche nach dem offenen Issue, um zu überprüfen, ob eine andere Person dasselbe gemeldet hat. Wenn es sich um ein neues Thema handelt, öffne mithilfe einer Vorlage ein Issue. Wir verwenden das Issue, um eine Unterhaltung über das Problem zu führen, das behoben werden soll.
Note
GitHub-Mitarbeitende sollten Issues im privaten docs-content-Repository erstellen.
Pull Requests
Ein Pull Request ist eine Möglichkeit, Änderungen in unserem Repository vorzuschlagen. Wenn wir diese Änderungen zusammenführen, werden sie innerhalb von 24 Stunden auf der Livewebsite bereitgestellt.
Wir können keine Beiträge zur REST-API-Referenzdokumentation akzeptieren. Wenn du in der Referenzdokumentation zur REST-API eine Ungenauigkeit feststellst, öffne ein Issue im rest-api-description-Repository.
Wir dokumentieren nur GitHub-Produkte, Features, Tools und Erweiterungen. Wir können Drittanbietertools erwähnen oder einen Link dazu angeben, um die Funktionsweise eines Feature zu veranschaulichen, aber wir akzeptieren keine Pull Requests zum Dokumentieren von Tools oder Integrationen von Drittanbietern, es sei denn, sie wurden mit GitHub gemeinsam entwickelt.
Überprüfen der eigenen Pull Requests
Überprüfe immer zuerst deinen eigenen Pull Request, bevor du ihn als bereit für die Überprüfung durch andere markierst.
Stelle bei Inhaltsänderungen Folgendes sicher:
- Vergewissere dich, dass die Änderungen die im Inhaltsentwurfsplan beschriebenen Benutzeroberflächenfunktionen und Ziele erfüllen (sofern vorhanden).
- Überprüfe den Inhalt auf technische Genauigkeit.
- Überprüfen Sie Ihre Änderungen auf Grammatik, Rechtschreibung und Einhaltung des Styleguide.
- Stelle sicher, dass der Text in deinen Pull Request einfach zu übersetzen ist. Weitere Informationen finden Sie unter Schreiben von zu übersetzenden Inhalten.
- Überprüfe neue oder aktualisierte Liquid-Anweisungen, um sicherzustellen, dass die Versionsverwaltung korrekt ist. Weitere Informationen finden Sie unter Dokumentation zur Versionierung.
- Sieh dir die Vorschau aller Seiten an, die du geändert hast. Eine Vorschau wird automatisch generiert, nachdem du einen Pull Request übermittelt hast, und dem Pull Request werden Links hinzugefügt. Es dauert manchmal einige Minuten, bis die Vorschau angezeigt wird. Vergewissere dich, dass alles wie erwartet gerendert wird. Wenn du die Vorschau überprüfst, kannst du Probleme wie Rechtschreibfehler und Inhalte erkennen, die nicht dem Styleguide entsprechen oder aufgrund von Versionsverwaltungsproblemen nicht gerendert werden. Überprüfe die gerenderte Ausgabe auf Listen und Tabellen, in denen manchmal Probleme auftreten, die im Markdown schwer zu identifizieren sind.
- Wenn in deinem Pull Request fehlerhafte Überprüfungen vorhanden sind, behebe sie, bis alles fehlerfrei ist.
Support
Wir sind ein kleines Team, das hart arbeitet, um den Dokumentationsanforderungen eines sich ständig ändernden Produkts gerecht zu werden. Leider können wir bei Supportfragen in diesem Repository nicht weiterhelfen. Wenn ein Problem mit GitHub auftritt, das nicht mit unserer Dokumentation zusammenhängt, wende dich direkt an den GitHub-Support. Alle Issues oder Pull Requests, die in diesem Dokumentationsrepository geöffnet wurden und Unterstützung erfordern, erhalten weitere Informationen dazu, wie du den GitHub-Support kontaktieren kannst, danach werden sie geschlossen und gesperrt.
Wenn du Probleme mit deinem GitHub-Konto hast, wende dich an den Support.
Translations
Diese Website ist internationalisiert und in mehreren Sprachen verfügbar. Der Quellinhalt in diesem Repository ist in englischer Sprache geschrieben. Wir automatisieren Übersetzungen durch einen internen Prozess und arbeiten mit professionellen Übersetzern und Übersetzerinnen zusammen, um die englischen Inhalte zu lokalisieren.
Wenn du einen Übersetzungsfehler feststellst, öffne ein Issue mit den Details.
Derzeit akzeptieren wir keine Pull Requests für übersetzte Inhalte.
Website-Richtlinie
Die Websiterichtlinien von GitHub werden auch auf docs.github.com veröffentlicht.
Wenn du im Abschnitt Websiterichtlinie einen Tippfehler findest, kannst du einen Pull Request öffnen, damit er behoben wird. Weitere Informationen findest du unter Mitwirken im site-policy-Repository.