Réception d'une demande d'examen de pull request¶

Votre pull request a été soumise et a passé le CI. Elle est maintenant prête à être examinée.

tl;dr - Le processus de révision¶

La version courte du processus d'examen :

Attendre une révision.
Répondre au retour d'information.
Si des modifications sont demandées :
Travailler à l'achèvement des modifications demandées.
Soumettre toutes les modifications demandées.
Demander à nouveau un réexamen lorsque toutes les modifications demandées ont été soumises.
Répéter la section 3 jusqu'à ce qu'aucune autre modification ne soit nécessaire.
Attendez que votre demande d'extraction soit approuvée et fusionnée.

Félicitations ! Vous venez d'apporter une contribution à BeeWare !

J'ai soumis ma pull request, quelle est la suite ?¶

Après avoir soumis votre demande d'extraction, vous devrez attendre la révision de votre contribution. Il y a deux aspects au processus de révision : fournir une révision et recevoir une révision.

Réviser les attentes

Vous devez vous attendre à ce que les personnes qui examinent vos propositions respectent ces lignes directrices, y compris les membres de l'équipe principale. Vous devez également suivre ces lignes directrices lorsque vous examinez des propositions d'autres personnes.

Si vous pensez que votre évaluateur s'éloigne de ces attentes, et que vous vous sentez à l'aise pour soulever le problème vous-même sur la demande d'extraction, vous pouvez le faire. Si vous ne vous sentez pas à l'aise, veuillez contacter l'équipe BeeWare Code of Conduct Response Team. Nous examinerons votre rapport et assurerons le suivi avec votre réviseur. Le suivi reflétera l'action signalée ; une transgression mineure peut donner lieu à une discussion, tandis qu'une violation majeure peut donner lieu à quelque chose de plus sérieux.

Fournir une évaluation¶

Tout le monde est invité à fournir une évaluation sur n'importe quelle demande d'extraction. Ces directives décrivent ce que nous attendons d'une révision, qu'elle soit fournie par un membre de l'équipe principale ou par un membre de la communauté.

Un membre de l'équipe centrale devra toujours procéder à l'examen final, mais les examens des membres de la communauté peuvent être un moyen utile de rationaliser le processus - dans l'idéal, l'examen de l'équipe centrale serait une formalité après que les examens de la communauté ont identifié tous les problèmes majeurs.

Recevoir un avis¶

La réception d'une révision se fait en trois étapes :

Premiers commentaires et questions.
Demandes de modification.
Approbation et fusion.

Chaque étape est détaillée ci-dessous. Si, à un moment ou à un autre de la procédure, vous avez des questions, n'hésitez pas à les poser ! Nous nous ferons un plaisir de vous aider.

Calendrier et premier retour d'information¶

L'équipe principale s'efforce de s'assurer que chaque demande est examinée dans un délai de dix jours ouvrables. Cependant, dans le cas de soumissions plus compliquées, ou lorsqu'une demande est soumise alors qu'une partie de l'équipe est en congé, ce délai peut être prolongé.

Nous maintenons généralement une continuité avec les réviseurs pour chaque demande d'extraction - c'est-à-dire que vous travaillerez probablement avec le même réviseur pour l'ensemble de votre révision. Cela signifie que votre réviseur disposera d'un contexte tout au long du processus et que vous serez en mesure d'apprendre à quoi vous attendre en termes de cadence de réponse et de style de révision. Si votre réviseur initial identifie qu'il n'a pas l'expertise nécessaire pour réviser vos demandes d'extraction, ou s'il sait qu'il ne sera pas disponible pour une raison quelconque, il peut transférer la responsabilité de votre demande d'extraction à un autre membre de l'équipe.

Vous pouvez vous attendre à ce que nous répondions à chaque échange dans un délai de dix jours ouvrables. Répondre aux commentaires et aux questions est un élément essentiel du processus d'évaluation. Nous attendons une réponse de votre part avant de passer à l'étape suivante du processus.

Demandes de modification¶

La plupart du temps, votre réviseur va demander des changements sur votre pull request. Ce n'est pas nécessairement un reflet de votre travail, cela fait simplement partie du processus.

Si l'examen initial révèle un nombre important de problèmes, le premier examen peut ne pas être complet. Au lieu de cela, elle se concentrera sur la fourniture d'une orientation de haut niveau sur le travail requis pour amener la demande de retrait dans un état fusionnable. Le processus de révision peut inclure des questions pour clarifier le but et l'étendue du travail qui a été tenté.

Travailler sur les changements demandés¶

Votre évaluateur publiera des commentaires sur votre demande d'extraction. Ces commentaires peuvent être généraux, sur un fichier spécifique, ou sur une ou plusieurs lignes de code spécifiques. Ils incluront parfois des suggestions de modifications que vous pourrez appliquer à votre demande via l'interface utilisateur de GitHub. Généralement, il s'agit de questions, de demandes de clarification ou de conseils sur les mises à jour.

Marquer une conversation comme résolue

Pendant la partie discussion du processus de retour d'information, vous ne devez jamais marquer une conversation entamée par votre évaluateur comme étant "résolue". C'est à l'évaluateur qu'il incombe de marquer la conversation comme résolue. C'est à lui de déterminer si le problème identifié a été résolu.

Si l'examen révèle un problème systématique (par exemple, une incohérence de dénomination dans le code), l'examinateur peut ne pas mettre en évidence tous les cas de ce problème. Au lieu de cela, il peut choisir quelques exemples du problème et indiquer que d'autres exemples devraient également être corrigés. Si une évaluation met en évidence un problème à un endroit et que vous pensez qu'il peut s'appliquer ailleurs, vous devez corriger ce problème là où il se trouve. En cas de doute, demandez des précisions à votre évaluateur.

Soumettre toutes les modifications demandées¶

Une fois que vous avez travaillé sur tous les changements demandés, vous pouvez envoyer une mise à jour à votre demande d'extraction. Cela déclenchera une nouvelle exécution du CI ; une fois que vous avez confirmé que le CI passe toujours, postez un commentaire demandant une mise à jour de la révision et l'équipe principale jettera un nouveau coup d'œil à votre demande d'extraction.

Poussez, ne forcez pas et ne rebaser pas

Lorsque vous mettez à jour votre demande d'extraction pendant une révision, il est important de laisser l'historique des livraisons intact. Cela n'a pas d'importance s'il y a une énorme liste de commits ; ils sont tous écrasés lorsque nous fusionnons la demande d'extraction. Si vous forcez le push ou le rebasement de votre demande d'extraction au milieu d'une révision, vous risquez de supprimer un contexte important dont votre réviseur a besoin.

Demander à nouveau un examen¶

Une fois que vous avez résolu tous les changements demandés dans un examen donné et que l'IC passe à nouveau, vous pouvez redemander un examen à votre examinateur. Si un problème est particulièrement compliqué, et que la résolution d'un élément aura un impact sur un autre, vous pouvez demander une révision sur l'élément spécifique que vous avez mis à jour. Nous partons du principe que toute demande de révision est une demande de révision complète. Si vous n'êtes pas prêt pour une révision complète, assurez-vous de spécifier exactement ce que vous recherchez.

Approbation et fusion des demandes d'extraction¶

Une fois que vous avez répondu à toutes les demandes de changement, la demande sera approuvée. Dans la plupart des cas, une fois la demande approuvée, nous la fusionnerons immédiatement. Dans certains cas, il peut y avoir des circonstances atténuantes, comme le fait de s'appuyer sur une autre demande de modification qui n'a pas encore été fusionnée, ce qui entraînera un retard. Nous communiquerons cela dans les commentaires, afin que vous soyez au courant de la situation.