Buts
Notre processus d'examen répond à plusieurs objectifs:
- Garantissez un code de haute qualité, tant au niveau des fonctionnalités que de la lisibilité.
- Identifiez les bugs, car des bugs se produisent.
- Conservez un style cohérent afin qu'il soit facile de commencer à travailler dans n'importe quelle partie du codebase.
Tout le code inclus dans blockly-samples et core Blockly est soumis à un examen, qu'il soit écrit par des contributeurs de la communauté ou par des membres de l'équipe Blockly.
En tant qu'examinateurs, nous nous efforçons de vous aider à améliorer les modifications apportées. En tant que contributeurs, nous vous invitons à discuter avec nous pour que vos demandes d'extraction soient examinées et fusionnées.
Procédure
Le processus d'examen des relations publiques comprend plusieurs étapes:
Assignment
Lorsque votre demande d'extraction arrive, le membre d'astreinte de l'équipe Blockly attribue un examinateur.
Les examinateurs sont choisis en fonction de leur expertise et pour répartir la charge de travail de manière homogène.
L'attribution d'un évaluateur à l'enquête peut prendre quelques jours, et quelques jours supplémentaires pour obtenir son avis. Ne vous inquiétez pas, c'est normal.
Commentaires
Au cours de cette étape, un examinateur vous suggère des modifications à apporter à votre RP. Ces opérations peuvent être simples afin de rendre votre code conforme au guide de style JavaScript de Google. Il peut aussi s'agir de choses plus vastes, comme vous demander de réorganiser les définitions de vos fonctions.
Les examinateurs sont encouragés à utiliser les examens de code de GitHub (plutôt que de faire des commentaires individuels) afin de recevoir une seule notification au lieu de plusieurs.
Discussion
La phase de discussion est votre chance de répondre au feedback. Peut-être que l'un des commentaires de l'avis n'était pas clair: vous avez maintenant l'occasion de demander des précisions. Ou peut-être que votre examinateur a demandé une modification, mais vous pensez que cela aura des répercussions: c'est maintenant l'occasion de trouver un compromis.
Révision
La phase de révision est le moment où vous pouvez apporter des modifications à votre PR. En général, ces modifications sont le résultat d'une action de votre évaluateur lors de la phase de commentaires.
Une fois vos révisions terminées, il peut être utile de taguer le réviseur pour lui demander de le réexaminer.
Répétition
Après la phase de révision, votre examinateur a une autre chance de faire part de ses commentaires, et le processus commence depuis le début.
Souvent, un deuxième examen est simple et se concentre sur les nits tels que la ponctuation et le style de code. Mais une deuxième révision peut parfois être assez importante. Votre premier évaluateur peut même demander à quelqu'un d'autre de jeter un œil, pour avoir une nouvelle perspective.
Fusionner !
La phase de fusion est l'occasion de célébrer. Vous avez créé une modification, en avez discuté et révisé, et l'avez finalement fusionné ! C'est une grande réussite que beaucoup de gens ne commencent jamais, et encore moins qu’elles terminent !
Merci pour tout le travail que vous avez fourni pour améliorer Blockly. Et félicitations !