git tuto
1.0.0
Dieses Repository hilft Ihnen dabei, die Grundlagen des Github -Flusses zu praktizieren und wie man an Open -Source -Projekten arbeitet.
Hier ist ein Link zu einer Präsentation zu Git im Allgemeinen: https://docs.google.com/presentation/d/1vfsg__2-t7xjygkfs9hfpkmaomn1je0v0h7glyiy1au/edit?usp=sharing
Diese Schritte gehen davon aus, dass Sie Git lokal installiert haben, dass Sie ein Github -Konto erstellt und Ihren lokalen SSH -Schlüssel hinzugefügt haben.
Geben Sie dieses Repo mit der Gabelstaste in der oberen rechten Ecke.
Klonen Sie Ihr Forked Repo vor Ort. git clone [email protected]:<your-github-handle>/git-tuto.git
Fügen Sie das ursprüngliche Projekt als entferntes Repo hinzu. git remote add upstream https://github.com/zaccharieramzi/git-tuto.git
Erstellen Sie eine neue Filiale, um Ihren Namen der Liste der Personen hinzuzufügen, die am Tutorial teilgenommen haben. git checkout -b <your-name-or-pseudonym>
Fügen Sie Ihren Namen der Datei participants.csv hinzu. echo '<your-name-or-pseudonym>,n' >> participants.csv
Bühne und begehen Sie Ihre Veränderungen. git add participants.csv && git commit -m'Added <your-name-or-pseudonym> to the participants file'
Schieben Sie Ihre lokale Niederlassung zu Ihrem entfernten Repo. git push origin <the-name-of-your-branch>
Öffnen Sie eine neue Pull-Anfrage (PR): https://github.com/zaccharieramzi/git-tuto/compare. Sie haben hier ein Beispiel PR.
Mit Feedback iterieren.
Sobald die PR (zusammengequetscht und) zusammengeführt wird, vergessen Sie nicht, Ihr lokales Repo ( git checkout master && git pull upstream master ) und Ihr Fern -Repo ( git push origin master ) zu aktualisieren.
Sobald Sie verstanden haben, wie der GitHub -Fluss funktioniert, können Sie versuchen, am Tutorial für Continuous Integration (CI) teilzunehmen. Aber zuerst, was ist CI? CI ist ein Prozess, der am besten als kontinuierliche Tests des Codes beschrieben werden kann, wenn Teile hinzugefügt werden. Dies stellt sicher, dass ein Neuzugang in der Codebasis das Verhalten des Codes nicht unerwartet ändert.
Es gibt viele Tools, aber wir werden hier nur Travis CI verwenden. Um es einzurichten, müssen Sie sich nur auf der Website registrieren, Ihr Repo zu der Liste der angesehenen Repositorys hinzufügen und dann Ihrem Projekt eine Travis -Konfigurationsdatei hinzufügen. Die Travis -Konfigurationsdatei ist eine YAML -Datei mit einer Liste von Anweisungen zum korrekten Ausführen der Tests.
Dies setzt voraus, dass Sie die Schritte 1-4 des Git-Tutorials unternommen haben.
Fügen Sie dem Funktionsordner eine Datei _function.py hinzu.
Schreiben Sie in dieser Datei eine einfache Funktion, die leicht getestet werden kann. Ein Beispiel ist meine Funktionsdatei. Die Funktion muss sich nicht um Zahlen handeln, kann sich jedoch um alle integrierten Datenstrukturen handeln, die Python bietet.
Fügen Sie einen entsprechenden Unit -Test für diese neue Funktion hinzu. Ein Beispiel für einen entsprechenden Unit -Test ist meine.
Führen Sie die Schritte 6-10 des Git-Tutorial mit der geringen Ausnahme aus, dass Sie eine besser geeignete Commit-Nachricht benötigen.
Mit den Problemen dieses Repo können Sie sowohl Verbesserungen in der Präsentation als auch in diesem Tutorial vorschlagen. Ein erster guter Beitrag könnte beispielsweise darin bestehen, die beitragenden Richtlinien hinzuzufügen.
