9.0 KiB

Raw Blame History

Wie man einen Pull-Request (PR) öffnet

Ein Pull-Request (PR) ermöglicht es dir, Änderungen von deinem Fork auf GitHub an FreeCodeCamp.orgs Hauptrepository zu senden. Wenn du mit den Änderungen am Code fertig bist, kannst du diese Richtlinien befolgen, um einen PR zu eröffnen.

Wir erwarten von unseren Mitwirkenden, dass sie den für dieses Projekt spezifischen Prozess kennen. Wenn du die Richtlinien gewissenhaft befolgst, verschaffe dir den Respekt deiner Kollegen und spare allen Beteiligten Zeit.

Einige Beispiele hierfür sind:

Bearbeite Dateien nicht direkt über GitHub - Das kannst du zwar, aber es ist keine gute Idee.
Achte darauf, dass du die PR-Checkliste befolgst und nicht nur Dinge abhakst, sonst nehmen wir dich nicht ernst.
Verwende die korrekte Art der Verknüpfung von Themen in der Beschreibung des PR, indem du die XXXXXX aktualisierst. Füge nicht einfach überall und nach Lust und Laune Heftnummern ein.
Erwähne jemanden nicht zu oft mit "@mention" oder bitte ihn nicht zu oft um Bewertungen.

Wir verstehen, dass du gerne einen Beitrag leisten möchtest. So gerne sich ein Betreuer auch bei dir melden würde, er hat alle Hände voll zu tun, um Hunderte von Anfragen wie deine zu bearbeiten. Habe Geduld, früher oder später wird sich jemand bei dir melden.
Arbeite nicht direkt an deinem Hauptzweig - erstelle einen neuen Zweig für die Änderungen, an denen du arbeitest.

[!NOTE] Deine Öffentlichkeitsarbeit sollte sich nur auf Änderungen des englischen Lehrplans beziehen. Lese stattdessen diesen Leitfaden, um zu Übersetzungen beizutragen.

Bereite einen guten PR-Titel vor

Wir empfehlen, konventionelle Titel und Nachrichten für Commits und Pull Requests zu verwenden. Die Konvention hat das folgende Format:

<type>([optional scope(s)]): <description>

Zum Beispiel:

fix(learn): tests for the do...while loop challenge

Wenn du einen Pull Request (PR) öffnest, kannst du den Typ, den Geltungsbereich (optional) und die Beschreibung festlegen.

Typ:

Typ	Wann wählen
fix	Geänderte oder aktualisierte/verbesserte Funktionalität, Tests, der Wortlaut einer Lektion, usw.
feat	Nur wenn du neue Funktionen, Tests usw. hinzufügst.
chore	Änderungen, die sich nicht auf den Code, die Tests oder den Wortlaut einer Lektion beziehen.
docs	Änderungen im Verzeichnis `/docs` oder in den Mitwirkungsrichtlinien, etc.

Geltungsbereich (Scope):

Du kannst einen Geltungsbereich aus dieser Liste von Labels auswählen.

Beschreibung:

Fasse dich kurz (weniger als 30 Zeichen) und einfach; du kannst weitere Informationen im PR-Beschreibungsfeld und in den Kommentaren hinzufügen.

Einige Beispiele für gute PR-Titel wären:

fix(a11y): improved search bar contrast
feat: add more tests to HTML and CSS challenges
fix(api,client): prevent CORS errors on form submission
docs(i18n): fix links to be relative instead of absolute

Einen Pull-Request vorschlagen

Sobald die Änderungen übertragen wurden, wirst du aufgefordert, einen Pull-Request auf der GitHub-Seite deines Forks zu erstellen.

Screenshot ansehen
Grundsätzlich sollten alle Pull-Requests gegen das Haupt-Repository von freeCodeCamp, den main-Branch, gerichtet sein.

Stelle sicher, dass dein Base Fork auf freeCodeCamp/freeCodeCamp eingestellt ist, wenn du einen Pull-Request einreichst.

Screenshot ansehen
Übermittle den Pull-Request von deinem Branch an den main-Branch von freeCodeCamp.
Füge eine ausführlichere Zusammenfassung der von dir vorgenommenen Änderungen und deren Nutzen in den Hauptteil deines PR-Textes ein.
- Du erhältst eine Vorlage für einen Pull-Request. Dies ist eine Checkliste, die du befolgen solltest, bevor du den Pull-Request öffnest.
- Fülle die Details so aus, wie du es für richtig hältst. Diese Informationen werden geprüft und die Prüfer entscheiden, ob dein Pull-Request angenommen wird oder nicht.
- Wenn der PR ein bestehendes GitHub Problem beheben soll, dann am Ende von der Beschreibungstext deines PR verwenden Sie das Schlüsselwort Schließt mit der Ticketnummer zu automatisch schließen, wenn der PR akzeptiert und zusammengeführt wird.
  
  Beispiel: Closes #123 wird Issue 123 schließen
Gib an, ob du auf einer lokalen Kopie der Website getestet hast oder nicht.
- Das ist sehr wichtig, wenn du Änderungen vornimmst, die nicht nur Textinhalte wie die Dokumentation oder eine Aufgabenbeschreibung betreffen. Beispiele für Änderungen, die lokal getestet werden müssen, sind JavaScript, CSS oder HTML, die die Funktionalität oder das Layout einer Seite verändern könnten.
- Wenn dein PR das Verhalten einer Seite beeinflusst, sollte er von entsprechenden Cypress Integrationstests begleitet werden.

Feedback zu Pull-Requests

🎉 für die Erstellung eines PR und vielen Dank, dass du dir die Zeit genommen haben, einen Beitrag zu leisten.

Unsere Moderatoren werden jetzt einen Blick darauf werfen und dir ein Feedback hinterlassen. Bitte habe Geduld mit den anderen Moderatoren und respektiere ihre Zeit. Alle Pull-Requests werden zu gegebener Zeit überprüft.

Und wie immer kannst du deine Fragen in der Kategorie "Contributors" in unserem Forum oder im "Contributors"-Chatraum stellen.

[!TIP] Wenn du mehr Pull-Requests beisteuern willst, empfehlen wir dir, die Richtlinien für Änderungen und Synchronisierung zu lesen, damit du deinen Fork nicht löschen musst.

Konflikte bei Pull-Requests

Es kann zu Konflikten kommen, weil viele Mitwirkende an dem Repository arbeiten und Änderungen deinen PR zerstören können, der noch auf eine Überprüfung und Zusammenführung wartet.

In den meisten Fällen brauchst du keinen Rebase, da wir alle Commits vernichten. Wenn jedoch ein Rebase verlangt wird, solltest du wie folgt vorgehen.

Für die üblichen Fehlerbehebungen und Funktionen

Wenn du an regulären Bugs und Features auf unserem Entwicklungszweig main arbeitest, kannst du einen einfachen Rebase durchführen:

Rebase deiner lokalen Kopie:

git checkout <pr-branch>
git pull --rebase upstream main

Löse alle Konflikte und füge Commits hinzu / bzw. bearbeite sie

# Entweder
git add .
git commit -m "chore: resolve conflicts"

# Oder
git add .
git commit --amend --no-edit

Schiebe deine Änderungen in den PR zurück
```
git push --force origin <pr-branch>
```

Für anstehende Studienpläne und Features

Wenn du an Funktionen für unseren kommenden next-*-Branch arbeitest, musst du Rosinenpickerei betreiben:

Achte darauf, dass dein Upstream mit deinem Local übereinstimmt:

git checkout main
git fetch --all --prune
git checkout next-python-projects
git reset --hard upstream/next-python-projects

Backup erstellen

a. Entweder löschst du deinen lokalen Branch, nachdem du ein Backup gemacht hast (wenn du ihn noch lokal hast):

git checkout <pr-branch-name>

# Beispiel:
# git checkout feat/add-numpy-video-question

git checkout -b <backup-branch-name>

# Beispiel:
#  git checkout -b backup-feat/add-numpy-video-question

git branch -D <pr-branch-name>

b. Oder einfach ein Backup deines PR-Branch (wenn du ihn nicht lokal hast):

git checkout -b <backup-branch-name> origin/<pr-branch-name>

# Beispiel:
#  git checkout -b backup-feat/add-numpy-video-question origin/feat/add-numpy-video-question

Beginne mit einer weißen Weste:

git checkout -b <pr-branch-name> next-python-projects
git cherry-pick <commit-hash>

Behebe alle Konflikte, bereinige, installiere Abhängigkeiten und führe Tests durch

npm run clean

npm ci
npm run test:curriculum --superblock=<superblock-name>

# Beispiel:

# npm run test:curriculum --superblock=python-for-everyone

Wenn alles gut aussieht, schickst du es zurück an den PR
```
git push --force origin <pr-branch-name>
```

9.0 KiB Raw Blame History