GitHub verwenden

Dieses GitHub-Tutorial basiert liebevoll auf dem [DjangoGirls How To Contribute Tutorial] (https://github.com/DjangoGirls/tutorial), das unter einer Creative Commons Attribution-ShareAlike 4.0 Lizenz verfügbar ist.

Für dieses Tutorial werden wir das Briefcase als Grundlage für die Links und Referenzen.

Erste Schritte und Voraussetzungen

Um einen Beitrag zu BeeWare leisten zu können, ist Folgendes erforderlich:

• ein GitHub-Konto
• im Falle komplexer Bearbeitungen Vertrautheit mit Git-Befehlszeile Grundlagen oder Vertrautheit mit einer App (Windows und Mac), um die Ihre auf Ihrem Computer vorgenommenen Änderungen auf GitHub zu übertragen.

Fork the repository

Forken Sie zunächst das Briefcase Repository in Ihr persönliches GitHub-Konto:

Bearbeitung der Dokumentation

Einfache Änderungen

Für einfache Änderungen wie Tippfehlerkorrekturen können Sie den GitHub Online Editor verwenden:

• Öffnen Sie Ihre lokale Fork-Seite auf GitHub,
• gehen Sie zur Datei README.rst in einem beliebigen Kapitel,
• drücken Sie das Bearbeiten Symbol (Stift)

und Sie können das Kapitel direkt auf github.com bearbeiten.

Die RST-Syntax wird zur Bearbeitung der einzelnen Seiten der Dokumentation verwendet.

Hinweis

Speichern Sie Ihre Änderungen und erstellen Sie einen Pull-Request wie unten beschrieben.

Neuer Code und komplexe Änderungen

Um neuen Code hinzuzufügen, Klassen zu erweitern oder komplexe Änderungen vorzunehmen, müssen Sie eine Kopie des Codes auf Ihren lokalen Computer übertragen.

Verwenden Sie entweder die GitHub-App für Ihr Betriebssystem (siehe oben) oder git Kommandozeile, um das Repository lokal abzurufen. Sie erhalten die Repository Adresse von der Startseite Ihres eigenen GitHub-Repository-Gabels:

git clone git@github.com:yourusername/briefcase.git

Erstellen Sie dann einen Zweig, in dem Ihre neuen Änderungen abgelegt werden. Es ist hilfreich, den Zweig Zweig einen Namen zu geben, der sich auf die Änderungen bezieht, die Sie vornehmen wollen.

git checkout -b update_documentation

Nehmen Sie Änderungen am Code vor, testen Sie sie und speichern Sie sie lokal.

Übertragen Sie dann die Änderungen mit git und schieben Sie die Änderungen in Ihr entferntes GitHub-Repository.

Beispiel:

$ git status
Im Zweig update_documentation
Unverfolgte Dateien:
  (verwenden Sie "git add <Datei>...", um sie in die zu übertragenden Dateien aufzunehmen)

    README.rst

git add README.rst

$ git commit -m "README.rst Dokumentation für Briefcase aktualisieren"
[update_documentation fe36152] Gitbook-Screenshot hinzugefügt
 1 Datei geändert, 0 Einfügungen(+), 0 Löschungen(-)
 Modus erstellen 100644 README.rst

$ git push
Zähle Objekte: 11, fertig.
Delta-Komprimierung mit bis zu 8 Threads.
Komprimiert Objekte: 100% (5/5), erledigt.
Schreiben von Objekten: 100% (5/5), 266.37 KiB | 0 bytes/s, erledigt.
Insgesamt 5 (delta 1), wiederverwendet 0 (delta 0)
An git@github.com:yourusername/briefcase.git
   b37ca59..fe36152 update_documentation -> update_documentation

Einen Pull-Antrag stellen

Nachdem Sie Ihre Änderungen abgeschlossen haben, müssen Sie eine Pull Anfrage auf GitHub. BeeWare wird über den Pull-Request benachrichtigt, überprüft Ihre Änderungen, schlägt ggf. Korrekturen vor und zieht dann Ihre Änderungen in die in die Hauptversion.

In Ihrem eigenen Repository auf GitHub drücken Sie Compare & pull request

Füllen Sie die Informationen aus, warum diese Änderung vorgenommen wird. Der Prüfer kann die Details der eigentlichen Änderung sehen, so dass Sie den Inhalt der Änderung nicht Inhalt der Änderung zu wiederholen.

Drücken Sie dann Create pull request.

GitHub benachrichtigt Sie per E-Mail über den Folgeprozess.

---