conventionalcomments.iogithub ↗LangueEN/FRL'adopter dans mon équipe

doc / diagnostic

Quand quelque chose ne fonctionne pas comme prévu

La plupart des comportements qui surprennent au premier abord sont intentionnels. Pour chaque cas ci-dessous, vous trouverez ce que vous observez, pourquoi cela se produit et ce que vous devez éventuellement faire.

La barre de labels n'apparaît pas

  • ·Le domaine n'est pas encore autoriséL'extension ne fonctionne que là où vous l'avez autorisée, github.com compris : fraîchement installée, elle n'est active nulle part tant que vous ne lui accordez pas un premier domaine depuis ses réglages. Pour un domaine qu'elle ne connaît pas déjà — une instance auto-hébergée, un serveur interne —, vous devez également indiquer quelle plateforme y est hébergée afin que l'extension utilise le bon adaptateur.
  • ·Un sélecteur de l'extension n'a rien trouvéQuand l'élément que cherche une règle n'est pas là, l'extension désactive la zone concernée plutôt que de risquer d'interagir avec le mauvais élément. Cela peut vouloir dire que la plateforme a changé son balisage — ou simplement que l'élément est légitimement absent, comme le bouton de fusion sur une pull request fermée. La section « État » de la page de réglages conserve les cinquante derniers événements de ce type, avec uniquement le nom de la règle concernée et l'horodatage — jamais le contenu des revues.
  • ·Le mode est offLa configuration de l'organisation ou du dépôt peut désactiver complètement l'extension.

Bandeau « configuration non lue »

L'extension n'a pas pu récupérer .conventional-comments.json. Elle continue de vous assister, mais puisqu'elle ne connaît pas les règles du dépôt, elle ne bloque jamais l'envoi d'un commentaire. Ce comportement est volontaire : personne ne doit être empêché de travailler au nom d'une règle que l'extension elle-même n'a pas réussi à lire.

ce que ce bandeau ne signifie pas

Un dépôt qui ne contient aucun fichier .conventional-comments.json n'est ni en erreur ni en mode dégradé. Dans ce cas, les valeurs par défaut du produit s'appliquent et aucun bandeau n'est affiché. Le bandeau apparaît uniquement lorsqu'une configuration est censée être accessible mais que l'extension ne parvient pas à la lire. Sur un dépôt public — ou sur un dépôt privé auquel vous êtes connecté — vous ne devriez normalement pas le voir. Si vous êtes déconnecté d'un dépôt privé, le bandeau indique simplement que la configuration n'est pas accessible.

/rebase est refusé

C'est le comportement attendu : toolCommands est vide par défaut, donc rien n'est exempté tant que le dépôt ne l'a pas déclaré.

"toolCommands": ["/*", "@dependabot", "@renovate"]

"/*" permet de reconnaître toutes les commandes commençant par /. Les identifiants de bots sont déclarés individuellement et la comparaison porte sur l'intégralité du premier token. Par exemple, @codex review est reconnu comme une commande, contrairement à @codexplique pourquoi.

Les commentaires d'un bot font échouer la vérification

Ajoutez son identifiant sur la plateforme à exemptUsers. La comparaison ne tient pas compte de la casse et utilise l'identifiant de connexion, jamais le nom affiché.

Les entrées générées directement par la plateforme — événements de timeline, mises à jour de branche, notifications système — sont automatiquement exemptées et n'ont pas besoin d'être déclarées. Une approbation envoyée sans aucun texte est également toujours exemptée. Sans cette règle, approuver simplement une pull request sans écrire de commentaire provoquerait une erreur de validation que l'auteur de la PR ne pourrait même pas corriger, puisqu'il ne peut pas modifier la revue de quelqu'un d'autre.

Un point bloquant ne peut pas être résolu

Un fil bloquant ne peut être résolu que par :

  • l'auteur du commentaire bloquant, ou
  • un membre du groupe autorisé à passer outre une résolution.

Si personne ne peut le résoudre, le groupe désigné est probablement vide. La présence de ce groupe est précisément un prérequis de enforce, afin qu'un fil bloquant ne puisse jamais se retrouver sans personne autorisée à intervenir.

L'autre possibilité consiste à répondre avec un decision expliquant pourquoi le point ne sera pas traité. Cette justification doit contenir au moins vingt caractères. Elle est enregistrée directement dans le fil : la dérogation reste donc toujours explicite et visible.