Überprüfung einer Pull-Anfrage erhalten¶
Ihr Pull Request wurde eingereicht und hat CI passiert. Sie ist nun bereit, überprüft zu werden.
tl;dr - Der Überprüfungsprozess¶
Die Kurzfassung des Überprüfungsverfahrens:
- Warten Sie auf eine Rezension.
- Reagieren Sie auf Feedback.
- Falls Änderungen gewünscht werden:
- Erledigen Sie die gewünschten Änderungen.
- Reichen Sie alle gewünschten Änderungen ein.
- Beantragen Sie eine erneute Überprüfung, wenn alle gewünschten Änderungen eingereicht wurden.
- Wiederholen Sie den dritten Abschnitt, bis keine weiteren Änderungen mehr erforderlich sind.
- Warten Sie darauf, dass Ihr Pull-Request genehmigt und zusammengeführt wird.
Herzlichen Glückwunsch! Sie haben soeben einen Beitrag zu BeeWare geleistet!
Ich habe meinen Pull Request eingereicht, wie geht es weiter?¶
Nachdem Sie Ihren Pull Request eingereicht haben, müssen Sie auf eine Überprüfung Ihres Beitrags warten. Der Überprüfungsprozess hat zwei Seiten: das Einreichen einer Überprüfung und das Erhalten einer Überprüfung.
Erwartungen überprüfen
Sie sollten erwarten, dass jeder, der Ihre Beiträge begutachtet, diese Richtlinien befolgt, auch die Mitglieder des Kernteams. Sie sollten diese Richtlinien auch befolgen, wenn Sie Beiträge von anderen prüfen.
Wenn Sie das Gefühl haben, dass Ihr Prüfer von diesen Erwartungen abweicht, und Sie sich wohl dabei fühlen, das Problem selbst in der Pull-Anfrage anzusprechen, können Sie dies tun. Wenn Sie sich dabei nicht wohl fühlen, wenden Sie sich bitte an das BeeWare Code of Conduct Response Team. Wir werden Ihren Bericht prüfen und uns mit Ihrem Prüfer in Verbindung setzen. Das Follow-up wird die gemeldete Aktion widerspiegeln; ein kleinerer Verstoß kann zu einer Diskussion führen, während ein größerer Verstoß zu etwas Ernsterem führen kann.
Eine Bewertung abgeben¶
Jeder ist willkommen, eine Rezension zu einer Pull-Anfrage abzugeben. [Diese Richtlinien (../how/review-pr.md) beschreiben unsere Erwartungen an eine Überprüfung, unabhängig davon, ob sie von einem Mitglied des Kernteams oder einem Mitglied der Gemeinschaft durchgeführt wird.
Ein Mitglied des Kernteams wird immer die abschließende Überprüfung vornehmen müssen, aber die Überprüfung durch Mitglieder der Gemeinschaft kann ein hilfreiches Mittel sein, um den Prozess zu straffen - idealerweise wäre die Überprüfung durch das Kernteam eine Formalität, nachdem die Überprüfung durch die Gemeinschaft alle wichtigen Probleme identifiziert hat.
Erhalt einer Bewertung¶
Der Erhalt einer Überprüfung umfasst drei grundlegende Schritte:
- Erste Rückmeldungen und Fragen.
- Änderungswünsche.
- Genehmigung und Zusammenführung.
Jeder Schritt wird im Folgenden ausführlich beschrieben. Wenn Sie zu irgendeinem Zeitpunkt des Prozesses Fragen haben, zögern Sie nicht zu fragen! Wir helfen Ihnen gerne weiter.
Zeitplan und erstes Feedback¶
Das Kernteam ist bestrebt, jeden Pull Request innerhalb von zehn Werktagen zu prüfen. Bei komplizierteren Anträgen oder wenn ein Pull Request eingereicht wird, während Teile des Teams im Urlaub sind, kann sich diese Frist jedoch verlängern.
In der Regel halten wir die Kontinuität mit den Prüfern bei jeder Pull-Anfrage aufrecht - das heißt, Sie werden wahrscheinlich mit demselben Prüfer für Ihre gesamte Prüfung arbeiten. Das bedeutet, dass Ihr Prüfer während des gesamten Prozesses einen Kontext hat und Sie lernen können, was Sie in Bezug auf die Antwortkadenz und den Prüfungsstil erwarten können. Wenn Ihr anfänglicher Prüfer feststellt, dass er nicht über das nötige Fachwissen verfügt, um Ihre Pull-Requests zu prüfen, oder er weiß, dass er aus irgendeinem Grund nicht verfügbar sein wird, kann er die Verantwortung für Ihren Pull-Request an ein anderes Teammitglied abgeben.
Sie können davon ausgehen, dass wir auf jeden Austausch innerhalb von zehn Arbeitstagen antworten. Die Beantwortung von Feedback und Fragen ist ein wesentlicher Bestandteil des Überprüfungsprozesses. Wir erwarten eine Antwort von Ihnen, bevor wir zum nächsten Schritt des Prozesses übergehen.
Änderungswünsche¶
In den meisten Fällen wird Ihr Prüfer Änderungen an Ihrem Pull Request verlangen. Dies ist nicht unbedingt ein Spiegelbild Ihrer Arbeit, es ist einfach Teil des Prozesses.
Wenn die erste Überprüfung eine beträchtliche Anzahl von Problemen aufzeigt, ist die erste Überprüfung möglicherweise nicht umfassend. Stattdessen wird sie sich darauf konzentrieren, eine grobe Richtung für die Arbeit vorzugeben, die erforderlich ist, um den Pull Request in einen zusammenführbaren Zustand zu bringen. Der Überprüfungsprozess kann Fragen beinhalten, um den Zweck und den Umfang der Arbeit zu klären, die versucht worden ist.
Bearbeitung der Änderungswünsche¶
Ihr Prüfer wird Kommentare zu Ihrer Pull-Anfrage veröffentlichen. Diese Kommentare können allgemein, zu einer bestimmten Datei oder zu einer oder mehreren bestimmten Codezeilen sein. Manchmal enthalten sie direkte Änderungsvorschläge, die Sie über die GitHub-Benutzeroberfläche auf Ihre Pull-Anfrage anwenden können. In der Regel handelt es sich um Fragen, Bitten um Klärung oder Hinweise zu Aktualisierungen.
Ein Gespräch als gelöst markieren
Während des Diskussionsteils des Feedback-Prozesses sollten Sie niemals eine von Ihrem Prüfer begonnene Unterhaltung als "gelöst" markieren. Die Kennzeichnung des Gesprächs als "gelöst" liegt in der Verantwortung des Beurteilers. Es liegt in seiner Verantwortung zu entscheiden, ob das Problem gelöst wurde.
Wenn die Überprüfung ein systematisches Problem aufdeckt (z.B. eine Unstimmigkeit bei der Namensgebung im Code), muss der Prüfer nicht jede Instanz dieses Problems hervorheben. Stattdessen kann er ein paar Beispiele für das Problem herausgreifen und darauf hinweisen, dass auch andere Beispiele korrigiert werden sollten. Wenn ein Review ein Problem an einer Stelle hervorhebt und Sie denken, dass es auch an anderen Stellen auftreten könnte, sollten Sie das Problem beheben, wo auch immer es auftritt. Wenn Sie sich unsicher sind, bitten Sie den Prüfer um eine Klarstellung.
Alle gewünschten Änderungen einreichen¶
Sobald Sie alle geforderten Änderungen durchgeführt haben, können Sie eine Aktualisierung Ihrer Pull-Anfrage veröffentlichen. Dadurch wird ein neuer CI-Lauf ausgelöst. Sobald Sie bestätigt haben, dass die CI immer noch funktioniert, posten Sie einen Kommentar mit der Bitte um eine aktualisierte Überprüfung und das Kernteam wird sich Ihre Pull-Anfrage erneut ansehen.
Drücken, nicht zwingen oder rebasen
Wenn Sie Ihren Pull Request während einer Überprüfung aktualisieren, ist es wichtig, die Commit History intakt zu lassen. Es spielt keine Rolle, ob es eine riesige Liste von Commits gibt; sie werden alle zerquetscht, wenn wir die Pull-Anfrage zusammenführen. Wenn Sie einen Push oder ein Rebase Ihres Pull Request mitten in einer Überprüfung erzwingen, entfernen Sie möglicherweise wichtigen Kontext, der von Ihrem Prüfer benötigt wird.
Erneut eine Bewertung anfordern¶
Sobald Sie alle geforderten Änderungen in einer bestimmten Überprüfung vorgenommen haben und die CI wieder in Ordnung ist, können Sie Ihren Prüfer erneut um eine Überprüfung bitten. Wenn ein Problem besonders kompliziert ist und die Behebung eines Problems sich auf ein anderes auswirkt, können Sie um eine Überprüfung des speziellen Teils bitten, den Sie aktualisiert haben. Es wird davon ausgegangen, dass jede Anfrage nach einer Überprüfung eine Anfrage nach einer vollständigen Überprüfung ist. Wenn Sie nicht bereit für eine vollständige Überprüfung sind, sollten Sie genau angeben, was Sie suchen.
Genehmigung von Pull-Anfragen und Zusammenführung¶
Sobald Sie auf alle Änderungswünsche geantwortet haben, wird der Pull Request genehmigt. In den meisten Fällen werden wir einen Pull Request sofort zusammenführen, sobald er genehmigt ist. In einigen Fällen kann es mildernde Umstände geben, wie z.B. die Abhängigkeit von einem anderen, noch nicht zusammengeführten Pull Request, die zu einer Verzögerung führen. Wir werden dies in den Kommentaren mitteilen, damit Sie über die Situation Bescheid wissen.