Répondre à une remarque de révision
Résoudre une remarque de révision de code en insérant un commentaire explicatif au bon endroit dans le code source, afin que les futurs relecteurs ne soulèvent pas la même préoccupation.
Entrées
Déduire les deux entrées du contexte de la conversation. Demander seulement en cas d'ambiguïté.
Entrée 1 — La remarque.
Une constatation d'un relecteur : généralement une ligne de tableau avec un emplacement (fichier:ligne) et une description de la préoccupation.
Le tableau provient généralement de la compétence dakubo-display-pr-remarks ou dakubo-review-commit-range. Si aucun tableau n'est présent dans la conversation et que l'une de ces compétences est disponible, l'utiliser pour créer le tableau. Sinon, demander la remarque à l'utilisateur.
Entrée 2 — L'explication. La réponse du développeur : pourquoi le code est correct en l'état, la décision de conception derrière celui-ci, le compromis accepté ou le contexte général que le relecteur a manqué. Cela ne contredit pas nécessairement directement la remarque — cela peut simplement changer la perspective du relecteur.
Processus
- Lire le fichier à l'emplacement spécifié dans l'Entrée 1.
- Identifier la construction exacte que la remarque cible (méthode, bloc, champ, ligne).
- Rédiger un commentaire qui :
- Capture l'essence de l'Entrée 2 (le raisonnement / la décision / le contexte).
- Est concis — une à quatre lignes maximum.
- Ne mentionne pas le relecteur, la PR ou le numéro de la remarque (les commentaires survivent aux révisions).
- Ne répète pas ce que le code dit déjà — ajouter uniquement le POURQUOI qui n'est pas évident à la lecture.
- Répond à la préoccupation de la remarque si cela rend l'explication plus claire, mais cela reste facultatif.
- Placer le commentaire immédiatement au-dessus de la construction ciblée, ou en ligne si un commentaire en fin de ligne s'intègre naturellement.
- Appliquer la modification.
Sortie
Confirmer le fichier et la ligne où le commentaire a été ajouté. Une phrase suffit.
Ce qu'il ne faut PAS faire
- Ne pas réécrire le code sauf si l'utilisateur le demande explicitement.
- Ne pas écrire un commentaire qui se contente de reformuler ce que fait le code.
- Ne pas faire référence à « le relecteur a dit… » ou « PR #N » à l'intérieur du commentaire.
- Ne pas ajouter un commentaire de plus d'environ 4 lignes ; si l'explication nécessite plus, elle appartient à un document de conception ou à un message de commit, pas à un commentaire en ligne.