Dokumentation in GitHub ändern

Wenn Du einen Fehler (Rechtschreibfehler, kleine inhaltliche Fehler, etc.) in der Dokumentation gefunden hast, klicke einfach auf den Edit on Github Link am rechten oberen Rand jeder Dokumentationsseite.

Damit wirst Du auf github.com geleitet. Mit einem Klick auf den Stift (siehe Bild) kannst Du das aktuelle Kapitel bearbeiten. Dafür müsst du Dich bei GitHub anmelden. Wenn Du noch kein Konto bei GitHub hast, kannst Du hier eines anlegen oder oben rechts auf „Sign up“ klicken.

Die Dokumentation ist in der Auszeichnungssprache „rST“ geschrieben. Hier findest Du einen guten Überblick über die am häufigsten verwendeten Elemente.

Im Beispiel wurde der Rechtschreibfehler und die Länge der zur Überschrift gehörenden Unterschreichung geändert.

Nachdem Du alle Änderungen vorgenommen hast, gib unten einen Titel und einen Kommentar ein. Die Änderungen können nun mit einem Klick auf „Propose file changes“ eingereicht werden.

Dein Änderungsvorschlag wird dann vom Dokumentationsteam geprüft und gegebenenfalls übernommen. Sekunden später erscheint die Änderung dann auch hier in der offiziellen Dokumentation.

Hinweis

Bitte beachte auch unbedingt die Leitlinien zur Dokumentation, damit Deine Änderungen schnell eingepflegt werden könnnen!

Sollest Du bereits Schreibrechte am Repositorium haben und bist Dir sicher, dass die Dokumentation durch Deine Änderung nicht beeinträchtigt wird, kannst Du die Änderungen direkt einbauen („Commit“) oder im Zweifel einen Zweig und einen so genannten Pull-Request erstellen.

Größere Änderungen an der Dokumentation sind immer über Pull-Requests zu erstellen. Dafür ist es nützlich, lokal eine Kopie (fork) vorzuhalten und Änderungen lokal zu testen, das im entsprechenden Kapitel erklärt wird.