Ihr erster Pull Request zum Prüfen
Eine Kollegin hat eine kleine Änderung geschrieben. Das Team nennt sie Pull Request. Sie sollen draufschauen, bevor sie in den gemeinsamen Code kommt.
Niemand erwartet, dass Sie jeden Fehler finden. Man erwartet, dass Sie ruhig lesen und hilfreich antworten.
Am Ende dieser Lektion
Notiz
Ich kann eine kleine Änderung prüfen und sagen, was besser sein kann.
Schlüsselwörter
| Begriff | Was er bedeutet | Beispiel |
|---|---|---|
| Code-Review | eine zweite Person liest die Änderung vor der Übernahme | |
| Pull Request | der Vorschlag, eine Änderung zu übernehmen | |
| Randfall | ein Wert an der Grenze, der den Code leicht bricht | eine leere Liste |
| Benennung | die Wahl der Namen für Variablen und Funktionen | |
| Kommentar | Ihre Anmerkung zu einer Zeile der Änderung |
Die Zellen, die Lernende ausfüllen, bleiben in dieser Vorschau leer.
Gute Namen sagen, was gemeint ist
Code wird öfter gelesen als geschrieben. Der Name ist die erste Erklärung.
Ein Name wie d oder l zwingt alle zum Raten. durchschnitt_bestellwert braucht keinen Kommentar. Schlagen Sie einen besseren Namen vor, wenn Sie beim Lesen stolpern.
Ausprobieren: den Vorschlag lesen
# Vorschlag einer Kollegin: durchschnittlicher Bestellwert.
def d(l):
s = 0
for x in l:
s = s + x
return s / len(l)
print(d([40.0, 60.0, 20.0]))
Fragen Sie nach dem Randfall
Lesen Sie die Änderung und fragen Sie: Was ist der seltsamste Wert, der hier ankommen kann?
Eine leere Liste, eine 0, eine negative Zahl, ein sehr großer Wert. Im Code oben teilt d([]) durch 0 und stürzt ab. Ein solcher Fund ist im Review viel wert.
Beispiel: Randfälle für den Durchschnitt
| Eingabe | Was passiert | Gut so? |
|---|---|---|
| [40.0, 60.0, 20.0] | Der Durchschnitt wird berechnet | Ja |
| [] | Absturz, geteilt durch 0 | Nein, melden |
| [0.0] | Ergebnis 0 | Ja |
| [-20.0, 30.0] | Ergebnis 5, ein negativer Wert zählt mit | Offen, nachfragen |
Die Zellen, die Lernende ausfüllen, bleiben in dieser Vorschau leer.
Ein häufiger Fehler
Warnung
Viele denken, ein Review sei Kritik an der Person. Es geht um den Code, nicht um die Kollegin. Beschreiben Sie die Stelle, nennen Sie den Grund und machen Sie einen Vorschlag.
Üben: Namen und Randfall verbessern
# Ihr Vorschlag: bessere Namen und der Randfall "keine Bestellungen".
def durchschnitt_bestellwert(bestellwerte):
if len(bestellwerte) == 0:
return 0
summe = 0
for wert in bestellwerte:
summe = summe + wert
return summe / len(bestellwerte)
print(durchschnitt_bestellwert([40.0, 60.0, 20.0]))
print(durchschnitt_bestellwert([]))
# Ergänzen Sie: Was soll bei negativen Werten passieren?
# Schreiben Sie dazu einen Kommentar-Satz in die Zeile unter dieser.
Ein guter Kommentar ist freundlich und genau
Vergleichen Sie zwei Kommentare. „Das ist schlecht.“ sagt nicht, was falsch ist.
„Zeile 6: Bei einer leeren Liste teilt die Funktion durch 0. Wollen wir in diesem Fall 0 zurückgeben?“ nennt die Stelle, den Grund und eine Frage. Das hilft, und es klingt nach Zusammenarbeit.