Bereitstellung einer Pull-Request-Überprüfung¶
Wir freuen uns immer über Rezensionen von Autoren, unabhängig von ihrem Erfahrungsstand.
Warum Beiträge überprüfen?¶
Jeder Beitrag, der eingereicht wird, muss überprüft werden, unabhängig davon, ob er von einem Mitglied des Kernteams oder einem Erstautor eingereicht wurde. Jeder hat die Möglichkeit, etwas zu übersehen. Der Überprüfungsprozess ist als zusätzliches Sicherheitsnetz gedacht.
Der Zweck des Überprüfungsprozesses ist es, sicherzustellen, dass alle Inhalte, einschließlich des Codes und der Dokumentation, so fehlerfrei und leicht zu pflegen wie möglich sind. Alles, was Sie tun können, um dieses Ziel zu erreichen, ist ein willkommener Beitrag. Dabei kann es sich um so einfache Dinge wie die Korrektur eines Tippfehlers handeln, aber auch um das Auffinden von Randfällen bei der API-Nutzung, die nicht erfasst werden. Sie könnten Möglichkeiten aufzeigen, wie das Testverfahren robuster gestaltet werden könnte, oder Vorschläge machen, wie die Gesamtarchitektur der Änderungen so strukturiert werden kann, dass sie leichter zu warten oder zu erweitern ist.
Kann ich das überprüfen?¶
Ja! Sie können für jede Pull-Anfrage, die Sie auf BeeWare sehen, eine Überprüfung anbieten.
Wenn Sie zum ersten Mal einen Beitrag leisten, sollten Sie sich frei fühlen, jeden Pull Request zu überprüfen, den Sie finden, auch wenn er von einem Mitglied des Kernteams eingereicht wurde. Wenn Sie ein Neuling sind, könnte Ihnen ein größerer Projektzusammenhang fehlen; aber wir versuchen, die Codebasis unabhängig von Ihrem Erfahrungsstand zugänglich zu halten. Wenn etwas im Code keinen Sinn ergibt, könnte das ein Hinweis darauf sein, dass mehr Dokumentation erforderlich ist (entweder im Code oder als eigenständige Design-Dokumentation).
Beitrag zur Überprüfung einer Pull-Anfrage¶
Bereitstellung einer Pull-Request-Prüfung
Jeder ist willkommen, jeden Beitrag zum BeeWare-Projekt zu überprüfen. Es gibt einige wichtige Überlegungen, die man beachten sollte, bevor man anfängt.
THINK before you review¶
Denken Sie nach, bevor Sie eine Rezension verfassen. Als Rezensenten sollten wir uns überlegen, ob die Antwort, die wir senden wollen, richtig ist:
- Wahr. Wir bemühen uns immer, genaue Vorschläge und Informationen zu liefern.
- Hilfreich. Wir geben Hinweise zur Verbesserung der Einreichung; diese Hinweise sollten die Ursache eines Problems oder eines nicht berücksichtigten Anwendungsfalls klar benennen und idealerweise einen Weg aufzeigen, wie das Problem gelöst oder befriedigt werden kann.
- Inspirierend. Es liegt an uns, den Autor zu inspirieren, unsere Änderungswünsche zu berücksichtigen.
- Erforderlich. Es wird erwartet, dass der Autor alles liest, was wir posten; wir müssen seine Zeit und Mühe respektieren, indem wir nur posten, wenn es notwendig ist.
- Freundlich. Es gibt mehrere Möglichkeiten, ein und dasselbe Feedback zu geben; wir müssen sicherstellen, dass wir mit unseren Worten freundlich, unterstützend und konstruktiv sind.
Es ist durchaus möglich, zu DENKEN und gleichzeitig eine wirksame Rezension zu verfassen. Die oben erörterten Konzepte schließen nicht aus, dass Sie auf Probleme hinweisen, die Sie bei einer PR finden. Die Mitwirkenden werden keine Gelegenheit haben, ihren Beitrag zu verbessern, wenn sie nicht wissen, dass es Bereiche gibt, die verbessert werden müssen. Wichtig ist, dass Sie sich bewusst sind, wie Sie dieses Feedback geben. Versuchen Sie, Ihre Beurteilung zu entpersonalisieren. Anstelle von "Du hast einen Fehler gemacht" können Sie sagen: "Dieser Code könnte verbessert werden". Bewerten Sie den Code, nicht den Autor.
Es ist wichtig, dass Sie nicht nur positive Rückmeldungen geben, sondern auch die verbesserungswürdigen Bereiche benennen. Wenn zum Beispiel die Änderungen besonders hilfreich sind, etwas besonders clever gemacht wurde oder Sie eine API kennengelernt haben, von der Sie noch nichts wussten, lassen Sie es den Autor wissen! Unterschätzen Sie niemals die Wirkung, wenn Sie auf etwas hinweisen, das jemand richtig oder gut gemacht hat, und das mitten in einer Situation, in der alles andere, worauf Sie hingewiesen haben, Probleme sind, die gelöst werden müssen.
GitHub-Review-Vorschläge¶
Die GitHub-Überprüfungsschnittstelle verfügt über einen Mechanismus für Änderungsvorschläge, bei dem Sie genau die Änderung angeben können, die Sie als Ersatz für den bestehenden Inhalt vorschlagen. Denken Sie daran, dass diese vorgeschlagenen Änderungen bis zur Annahme und Übergabe nicht durch die Pre-Commit- und Linting-Prüfungen laufen. Daher sollte diese Funktion für kleinere Änderungen verwendet werden, denn je größer die vorgeschlagene Änderung ist, desto wahrscheinlicher ist es, dass sie Probleme verursacht.