Un commentaire de révision devrait aider l’auteur à comprendre ce qui nécessite une attention particulière et pourquoi. Signalez un problème de comportement, de risque ou de maintenabilité spécifique au lieu de laisser une vague réaction sur une ligne de code.
Rendre le raisonnement visible
- Décrivez le scénario dans lequel le code actuel pourrait échouer ou dérouter un futur responsable.
- Séparez une correction requise ou un changement de sécurité d’une suggestion de style facultative.
- Posez une question lorsque vous manquez de contexte au lieu de supposer l'intention de l'auteur.
Proposer une voie à suivre
Lorsque cela est utile, proposez une alternative ou un test qui permettrait de résoudre le souci. Maintenir le changement demandé proportionnel à son impact ; ne faites pas d'une préférence personnelle un bloqueur de version.
Passez en revue le changement complet, pas seulement la décoration différentielle. Si un problème est suffisamment important pour bloquer la fusion, résumez-le clairement afin que l'auteur puisse trouver le travail restant.