GitubSession

Beitrag zu Open Source -Projekten mit Git

Willkommen in unserem Projekt! Wir freuen uns, dass Sie in Betracht ziehen, zur Open-Source-Entwicklung beizutragen. Dieser Leitfaden führt Sie durch die wesentlichen Git -Befehle und Best Practices, um Ihren Beitrag einfach und erfolgreich zu machen.

Inhaltsverzeichnis

1. Gabel des Repositorys
2. Klonen des Repositorys
3. Erstellen eines Zweigs
4. Änderungen vornehmen
5. Änderungen begehen
6. Änderungen drücken
7. Erstellen einer Pull -Anfrage
8. Synchronisieren Sie Ihre Gabel
9. Tipps zum Schreiben guter Feststellungsnachrichten

---

1. Das Repository Forking

Bevor Sie mitmachen, müssen Sie das Repository aufgeben. Gabing erstellt eine Kopie des Repositorys unter Ihrem eigenen GitHub -Konto.

Schritte:

1. Navigieren Sie zur Seite "Repository".
2. Klicken Sie in der oberen rechten Ecke auf die Schaltfläche "Fork".
3. Sie haben jetzt eine Kopie des Repositorys in Ihrem Github -Konto.

---

2. Klonen des Repositorys

Nachdem Sie das Repository gegabelt haben, müssen Sie es an Ihre lokale Maschine klonen, damit Sie daran arbeiten können.

git clone https://github.com/your-username/repository-name.git

---

3.. Erstellen eines Zweigs

Erstellen Sie nach dem Klonen des Repositorys eine neue Zweigstelle, um an Ihren Änderungen zu arbeiten. Arbeiten Sie immer in einem separaten Zweig, um Konflikte mit dem Hauptzweig zu vermeiden:

git checkout -b feature/your-branch-name

---

4. Änderungen vornehmen

Nehmen Sie jetzt, da Sie in Ihrer Niederlassung sind, die erforderlichen Änderungen an Code, Dokumentation oder anderen Teilen des Projekts vor. Testen Sie alles, bevor Sie mit dem nächsten Schritt fortfahren.

---

5. Änderungen begehen

Sobald Ihre Änderungen abgeschlossen sind, ist es Zeit, sie zu begehen. Folgen Sie folgenden Schritten:

1. Fügen Sie die Änderungen in den Staging -Bereich hinzu:

git add .

2. Beachten Sie die Änderungen mit einer klaren und beschreibenden Nachricht:

git commit -m " Your descriptive message here "

3. Stellen Sie sicher, dass Ihre Commit -Nachricht die von Ihnen vorgenommenen Änderungen deutlich erklärt.

6. Änderungen drücken

Nachdem Sie Ihre Änderungen vor Ort begangen haben, drücken Sie den Zweig in Ihr Github -Repository.

git push origin feature/your-branch-name

Dadurch wird Ihre Filiale in Ihr Gabel -Repository auf GitHub hochgeladen.

7. Erstellen einer Pull -Anfrage

Wenn Ihre Änderungen an GitHub weitergegeben werden, können Sie eine Pull -Anfrage (PR) einreichen, damit die Wartenden Ihre Arbeit überprüfen können.

• Navigieren Sie zu Ihrem Forked Repository auf GitHub.
  
• Klicken Sie auf die Schaltfläche "Vergleich & Pull -Anfrage".
  
• Geben Sie einen Titel und eine detaillierte Beschreibung Ihrer Änderungen an.
  
• Senden Sie die Pull -Anfrage.
  
• Nach der Überprüfung fusionieren die Betreuer entweder Ihre PR oder geben Feedback für Revisionen.
  

8. Synchronisieren Sie Ihre Gabel

Wenn das ursprüngliche Repository während der Arbeit aktualisiert wird, möchten Sie möglicherweise Ihre Gabel synchronisieren, um sie auf dem neuesten Stand zu halten. So wie: wie:

1. Fügen Sie das stromaufwärts gelegene Repository als Fernbedienung hinzu:

git remote add upstream https://github.com/original-owner/repository-name.git

2. Holen Sie sich die neuesten Änderungen aus dem Upstream -Repository:

git fetch upstream

3. Fusionieren Sie die stromaufwärtigen Änderungen in Ihre lokale Hauptzweig:

git checkout main
git merge upstream/main

4. Schieben Sie den aktualisierten Hauptzweig in Ihre Gabel:

git push origin main

9. Tipps zum Schreiben guter Commit -Nachrichten

• Halten Sie es präzise: Ziehen Sie eine Commit -Nachricht ab, die unter 50 Zeichen ist.
  
• Verwenden Sie die imperative Stimmung: Schreiben Sie beispielsweise "Fix -Fehler" anstelle von "Fehler behoben".
  
• Kontext bereitstellen: Fügen Sie die Problemnummer hinzu oder beschreiben Sie den Zweck der Änderung.
  Beispiel: Fix #42 - Fehler in der Benutzerauthentifizierung beheben.