Beitrag zu ord

Vorgeschlagene Schritte

  1. Finden Sie ein Problem, an dem Sie arbeiten möchten.
  2. Überlegen Sie, was der erste Schritt zur Lösung des Problems sein könnte. Dies könnte in Form von Code, Forschung, einem Vorschlag oder der Empfehlung erfolgen, es zu schließen, wenn es veraltet ist oder von vornherein keine gute Idee ist.
  3. Kommentieren Sie das Problem, skizzieren Sie Ihren vorgeschlagenen ersten Schritt und bitten Sie um Feedback. Natürlich können Sie sofort loslegen und mit dem Schreiben von Code oder Tests beginnen, aber das vermeidet potenziell verschwendeten Aufwand, wenn das Problem veraltet, nicht klar spezifiziert, an etwas anderem blockiert oder aus anderen Gründen nicht zur Implementierung bereit ist.
  4. Wenn das Problem eine Code-Änderung oder Fehlerbehebung erfordert, öffnen Sie einen Entwurfs-PR mit Tests und bitten Sie um Feedback. Dies stellt sicher, dass alle auf derselben Seite darüber sind, was getan werden muss, oder was der erste Schritt zur Lösung des Problems sein sollte. Da Tests erforderlich sind, erleichtert das Schreiben der Tests zuerst die Bestätigung, dass die Änderung leicht getestet werden kann.
  5. Mischen Sie die Tastatur nach dem Zufallsprinzip, bis die Tests bestanden sind, und überarbeiten Sie sie, bis der Code zur Übermittlung bereit ist.
  6. Markieren Sie die PR als zur Überprüfung bereit.
  7. Überarbeiten Sie die PR nach Bedarf.
  8. Und schließlich: mergies!

Fangen Sie klein an

Mit kleinen Änderungen können Sie schnell Wirkung erzielen, und wenn Sie den falschen Weg einschlagen, haben Sie nicht viel Zeit verschwendet.

Ideen für kleine Probleme:

  • Fügen Sie einen neuen Test oder Testfall hinzu, der die Testabdeckung erhöht
  • Dokumentation hinzufügen oder verbessern
  • Finden Sie ein Problem, das mehr Recherche erfordert, führen Sie diese Recherche durch und fassen Sie sie in einem Kommentar zusammen
  • Finden Sie ein veraltetes Problem und kommentieren Sie, dass es geschlossen werden kann
  • Finden Sie ein Problem, das nicht behoben werden sollte, und geben Sie konstruktives Feedback, in dem Sie darlegen, warum dies Ihrer Meinung nach der Fall ist

Mergen Sie frühzeitig und häufig

Teilen Sie große Aufgaben in mehrere kleinere Schritte auf, die jeweils Fortschritte machen. Wenn es einen Fehler gibt, können Sie eine Pull-Anfrage (PR) öffnen, die einen fehlgeschlagenen, ignorierten Test hinzufügt. Diese PR kann zusammengeführt werden, und der nächste Schritt könnte darin bestehen, den Fehler zu beheben und den Test nicht mehr zu ignorieren. Führen Sie umfangreiche Recherchen oder Tests durch und berichten Sie über Ihre Ergebnisse. Zerlegen Sie ein Feature in kleine Unterfeatures und implementieren Sie sie nacheinander.

Herauszufinden, wie man eine größere PR in kleinere PRs aufteilt, die jeweils zusammengeführt werden können, ist eine Kunstform, die es wert ist, geübt zu werden. Das Schwierige daran ist, dass jede PR selbst eine Verbesserung darstellen muss.

Ich bemühe mich, diesen Rat selbst zu befolgen, und es geht mir immer besser, wenn ich das tue.

Kleine Änderungen lassen sich schnell schreiben, überprüfen und zusammenführen, was viel mehr Spaß macht als an einer einzigen riesigen Pull-Anfrage (PR) zu arbeiten, die ewig dauert, um geschrieben, überprüft und zusammengeführt zu werden. Kleine Änderungen benötigen nicht viel Zeit, sodass Sie bei Bedarf aufhören können, an einer kleinen Änderung zu arbeiten, ohne viel Zeit zu verschwenden, im Vergleich zu einer größeren Änderung, die viele Stunden Arbeit repräsentiert. Wenn eine PR schnell eingereicht wird, verbessert dies das Projekt sofort ein wenig, anstatt lange auf größere Verbesserungen warten zu müssen. Kleine Änderungen sind weniger wahrscheinlich, Merge-Konflikte zu verursachen. Wie die Athener sagten: Die Schnellen commit , was sie wollen, die Langsamen merge was sie müssen.

Hilfe bekommen

Wenn Sie länger als 15 Minuten nicht weiterkommen, bitten Sie um Hilfe, z. B. bei Rust Discord, Stack Exchange oder bei einem Projektproblem oder einer Diskussion.

Üben Sie das hypothesis-driven debugging

Formulieren Sie eine Hypothese darüber, was das Problem verursacht. Überlegen Sie, wie Sie diese Hypothese testen können. Führen Sie diese Tests durch. Wenn es funktioniert, großartig, Sie haben das Problem behoben oder wissen jetzt, wie Sie es beheben können. Wenn nicht, wiederholen Sie den Vorgang mit einer neuen Hypothese.

Achten Sie auf Fehlermeldungen

Lesen Sie alle Fehlermeldungen und dulden Sie keine Warnungen.