Poster des commentaires d'examen Bitwarden
Protocole de commentaire GitHub
- OBLIGATOIRE Analyser tous les changements avant de poster quoi que ce soit
- OBLIGATOIRE Utiliser les commentaires inline pour les découvertes spécifiques au code
- OBLIGATOIRE Utiliser le format de découverte Bitwarden
- INTERDIT : NE PAS ajouter de sections "Strengths", "Highlights", ou observations positives.
- INTERDIT NE PAS poster de commentaires inline uniquement élogieux
- INTERDIT : NE PAS poster les métadonnées de PR (titre, description, plan de test) en commentaires inline. Ceux-ci vont dans le résumé seulement.
Format de découverte
CRITIQUE : Ne jamais utiliser # suivi de chiffres - GitHub créera automatiquement un lien vers des issues/PR non pertinentes.
- Écrire "#1" crée un lien cliquable vers l'issue/PR #1 (pas votre découverte)
- "Issue" est aussi une terminologie incorrecte (utiliser "Finding")
- Utiliser "Finding" + espace + numéro (pas de symbole #); viser moins de 30 mots dans la phrase
FORMAT CORRECT :
- Finding 1: Memory leak detected
- Finding 2: Missing error handling
FAUX (À NE PAS UTILISER) :
- ❌ Issue #1 (mauvais terme + autolink)
- ❌ #1 (autolink seulement)
- ❌ Issue 1 (mauvais terme seulement)
Commentaires inline
Chaque commentaire inline DOIT :
- Référencer la/les ligne(s) spécifique(s)
- Exposer le problème - qu'est-ce qui casse ou quel est le risque?
- Fournir une correction exploitable (pour ❌ et ⚠️)
- Être bref mais clair
- Utiliser des sections repliables pour les commentaires de plus de 5 lignes
- Inclure à la fois les balises
<details>d'ouverture ET de fermeture</details>
Règle de visibilité : Seulement la sévérité + description d'une ligne visible; tout le reste à l'intérieur des balises <details>.
Modèle pour les longs commentaires
[emoji] **[SEVERITY]**: [One-line issue description]
<details>
<summary>Details and fix</summary>
[Code example or specific fix]
[Rationale explaining why]
Reference: [docs link if applicable]
</details>
Sortie du résumé
Invoquer Skill(posting-review-summary) pour tout formatage de résumé et affichage.