Bereitstellung einer Pull-Request-Überprü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.