From ac730fa1ba50c8e5412d82caa9fc7e750d33c23b Mon Sep 17 00:00:00 2001 From: DanielErmilov Date: Tue, 24 Sep 2024 13:39:53 +0200 Subject: [PATCH] Anleitung Pull Request (#10) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Anleitung in README eingefügt * Moved anleitung in new File Anleitung.md * add anleitunglink --- Anleitung.md | 48 ++++++++++++++++++++++++++++++++++++++++++++++++ README.md | 2 +- 2 files changed, 49 insertions(+), 1 deletion(-) create mode 100644 Anleitung.md diff --git a/Anleitung.md b/Anleitung.md new file mode 100644 index 0000000..6e24c37 --- /dev/null +++ b/Anleitung.md @@ -0,0 +1,48 @@ +## Anleitung für einen Pull-Request + +### 1. Fork +Zuerst wird das Repository mit Fork in den eigenen Bereich kopiert. Dazu muss der```Fork```-Button im Repository gedrückt werden. + +### 2. Clone +Bevor ein Repository geklont werden kann, benötigt GitHub den eigenen SSH-Schlüssel. Dazu verwenden wird die Git GUI verwendet. Dort auf ```Help``` -> ```Show SSH Key``` klicken. Falls kein Key vorhanden ist, kann man einen neuen generieren lassen und optional ein Passwort setzen. Dieser Schlüssel muss in den GitHub Einstellungen auf ```SSH and GPG keys``` eingetragen werden. Danach kann Git lokal gestartet und das Repository mit den Befehlen geklont werden. Der Key kann in das Repository unter Code und SSH kopiert werden. +``` +git clone [GitHub SSH Key] +``` + +### 3. New Branch +Falls Änderungen vorgenommen werden müssen, empfiehlt es sich, diese in einem neuen Branch zu speichern. Dazu muss folgender Code in der Git-Bash eingegeben werden +```bash +git checkout -b [Branchname] +``` +### 4. Commit +Wenn alle Änderungen vorgenommen wurden, commitet (speichert) man die Änderungen in sein Lokales Repository. Zuerst müssen alle Änderungen ausgewählt werden. Dazu wird dieser Code in der Git Bash benötigt. +```bash +git add . +``` + +Um die Änderungen zu speichern benötigt man diesen Code. +```bash +git commit -m"[Nachricht]" +``` + +### 5. Push +Um alle Änderungen auf GitHub hochzuladen, muss der Push-Befehl eingegeben werden. Dieser lautet +```bash +git push +``` +Es kann sein, dass Git die Operation zunächst nicht zulässt, da der Branch kein Upstream ist. Git gibt jedoch den empfohlenen Code aus, um die Änderungen zu pushen. Dieser Code kann wie folgt aussehen +```bash +git push --set-upstream origin [Branchname] +``` + +### 6. Pull Request +Damit die Änderungen auch in dem Repository gespeichert werden, aus dem geforked wurde, wird ein Pull-Request benötigt. Der Pull-Request ist eine Anfrage an den Eigentümer des Repositories. Dieser kann entscheiden, ob die Änderungen übernommen werden sollen oder nicht. Wenn ihm etwas fehlt, kann er Kommentare hinzufügen. Einen Pull-Request erstellt man, indem man auf der Seite des Besitzers auf ```Pull-Request``` klickt. Dort klickt man auf ```New Pull Request```. Danach wählt man den Branch, in dem die Änderungen vorgenommen wurden und den Branch, in dem die Änderungen gespeichert werden sollen. Wenn alles ausgewählt ist, klickt man auf ```Create Pull Request```. + +### 7. Sync Fork +Nachdem der Besitzer den Pul Request akzeptiert hat, muss der Stand wieder aktualisiert werden, damit die Änderungen auch im main-Branch vorhanden sind. Dazu gibt es einen Button ``Sync`` und dann auf ``Update Sync`` klicken. + +### 8. Pull +Damit das Repository mit den Änderungen auch lokal gespeichert wird, muss man das Repository auf sein Profil ziehen. Dazu muss in der Git Bash folgender Code ausgeführt werden +```bash +git pull +``` \ No newline at end of file diff --git a/README.md b/README.md index 4b8f52c..65b1dd8 100644 --- a/README.md +++ b/README.md @@ -7,4 +7,4 @@ Das ist das Repository für die Übung im Kurs. ## git cheat sheet - [Grundbefehle](Grundbefehle.md) - +- [Pull-Request-Anleitung](Anleitung.md)