Fournir une révision de demande d'extraction¶

Nous sommes toujours heureux de recevoir des commentaires de la part des contributeurs, quel que soit leur niveau d'expérience.

Pourquoi revoir les contributions ?¶

Chaque contribution soumise doit être examinée, qu'elle ait été soumise par un membre de l'équipe centrale ou par un nouveau contributeur. Tout le monde est susceptible d'oublier quelque chose. Le processus d'examen est en place pour fournir un filet de sécurité supplémentaire.

L'objectif du processus de révision est de s'assurer que tout le contenu, y compris le code et la documentation, est aussi exempt de bogues et facile à maintenir que possible. Tout ce que vous pouvez faire pour atteindre cet objectif est une contribution bienvenue. Cela peut aller de la simple correction d'une coquille à la découverte de cas limites dans l'utilisation de l'API qui ne sont pas pris en compte. Vous pouvez identifier comment le régime de test pourrait être plus robuste, ou suggérer des moyens de structurer l'architecture globale des changements afin qu'ils soient plus faciles à maintenir ou à étendre.

Puis-je réviser ?¶

Oui ! Vous pouvez proposer une évaluation sur n'importe quelle demande d'extraction que vous voyez ouverte sur BeeWare.

En tant que nouveau contributeur, vous devriez vous sentir libre d'examiner toute demande d'extraction que vous trouvez, même si elle a été soumise par un membre de l'équipe principale. Si vous êtes novice, il se peut que le contexte du projet vous échappe, mais nous souhaitons que la base de code reste accessible quel que soit votre niveau d'expérience. Si quelque chose dans le code n'a pas de sens, cela peut indiquer qu'il y a un besoin de documentation supplémentaire (soit dans le code, soit en tant que documentation de conception indépendante).

Contribuer à l'examen d'une demande d'extraction¶

Fournir une révision de demande d'extraction

Tout le monde est invité à examiner toute contribution au projet BeeWare. Il y a quelques considérations importantes à prendre en compte avant de commencer.

Réfléchissez avant de réviser¶

Avant de vous engager dans une évaluation, RÉFLÉCHISSEZ. En tant qu'évaluateurs, nous devons nous demander si la réponse que nous nous apprêtons à envoyer est.. :

C'est vrai. Il faut toujours s'efforcer de fournir des suggestions et des informations exactes.
Utile. Nous fournissons des conseils sur la manière d'améliorer la soumission ; ces conseils doivent clairement identifier la source d'un problème ou d'un cas d'utilisation non pris en compte, et idéalement fournir une voie à suivre pour résoudre ou satisfaire le problème.
Inspirer. C'est à nous d'inspirer l'auteur pour qu'il ait envie de travailler sur les changements que nous avons demandés.
Nécessaire. On s'attend à ce que l'auteur lise tout ce que nous publions ; nous devons respecter son temps et ses efforts en ne publiant que lorsque c'est nécessaire.
Gentillesse. Il existe de multiples façons de présenter le même retour d'information ; nous devons nous assurer que nous choisissons d'être aimables, encourageants et constructifs dans nos propos.

Il est tout à fait possible de PENSER, tout en fournissant une évaluation efficace. Les concepts évoqués ci-dessus n'empêchent pas de signaler les problèmes que l'on peut rencontrer dans un PR. Les contributeurs n'auront pas la possibilité d'améliorer leur contribution s'ils ne sont pas conscients des points à améliorer. L'important est de rester conscient de la manière dont vous présentez ce retour d'information. Essayez de dépersonnaliser votre évaluation. Au lieu de dire "Vous avez fait une erreur", vous pouvez dire "Ce code pourrait être amélioré". Examinez le code, pas l'auteur.

Il est important de ne pas oublier de fournir un retour d'information positif en plus d'identifier les domaines à améliorer. Si, par exemple, les modifications sont particulièrement utiles, si vous faites quelque chose de particulièrement intelligent ou si vous découvrez une API que vous ne connaissiez pas, faites-le savoir à l'auteur ! Ne sous-estimez jamais l'effet que peut avoir le fait de souligner quelque chose que quelqu'un a fait correctement ou bien, au milieu d'une situation où tout ce que vous avez souligné est un problème qui doit être résolu.

Suggestions de révision sur GitHub¶

L'interface de révision de GitHub dispose d'un mécanisme pour les suggestions de changement, dans lequel vous pouvez fournir le changement exact que vous suggérez en remplacement du contenu existant. Gardez à l'esprit que, jusqu'à ce qu'ils soient acceptés et livrés, ces changements suggérés ne seront pas exécutés par la pré-commission et les vérifications de linting. Par conséquent, cette fonctionnalité devrait être utilisée pour des changements plus petits, car plus le changement suggéré est important, plus il est susceptible d'introduire des problèmes.