doc

Documentation

Trois façons de commencer. Choisissez directement celle qui correspond à votre besoin.

Je veux l'essayer

Vous voulez voir comment ça fonctionne sur vos propres pull requests, sans avoir besoin de demander la permission à qui que ce soit.

Installer l'extensionInstallez-la depuis le store d'extensions de votre navigateur, ou utilisez l'archive d'une release si vous ne pouvez pas compiler localement. Quelques minutes suffisent.Labels et indications visuellesDécouvrez les treize labels, leur signification et la règle qui détermine si un commentaire est bloquant.

Je configure un dépôt

L'équipe est convaincue. Vous voulez maintenant que tout le monde suive les mêmes règles.

ConfigurationUn seul fichier sur la branche par défaut. Voyez quelles options sont importantes, quels pièges éviter et comment les trois niveaux de configuration s'articulent.Adoptionassist → warn → enforce. Comprenez ce que change chaque étape et comment revenir rapidement en arrière si nécessaire.

Je veux savoir ce qui est prévu ensuite

Vous voulez que la convention puisse, à terme, être appliquée indépendamment de ce que chacun a installé dans son navigateur. Découvrez comment Enforce est envisagé et pourquoi son implémentation reste volontairement ouverte.

Enforce (feuille de route)Pourquoi le contrôle au niveau de la plateforme n'est pas encore disponible, ce que l'extension sait déjà faire sans lui et pourquoi son implémentation future n'est pas encore figée.DiagnosticComprenez les bandeaux et les quelques comportements qui surprennent souvent lors de la première utilisation.

Référence

Des références stables, conçues pour être exploitées aussi bien par les outils que par les développeurs.

Le schéma de configuration est disponible sur conventionalcomments.io/schema/v1.json. Ajoutez-le à la propriété $schema de votre fichier pour bénéficier de l'autocomplétion et voir les erreurs directement dans votre éditeur.
La spécification Conventional Comments est disponible sur conventionalcomments.org. Ce site propose des outils indépendants autour de celle-ci, mais ne définit ni ne représente la spécification.
Le code source est disponible sous licence Apache-2.0 et contient la spécification normative ainsi que l'ensemble des critères d'acceptation.