conventionalcomments.iogithub ↗EN/FRBring it to your team

docs

Documentation

Three ways in. Start with the one that fits what you're trying to do.

I'm trying it out

You want to see how it works on your own pull requests, without needing anyone else's permission.

Install the extensionGet it from your browser's extension store, or use a release archive if building locally isn't an option. You'll be up and running in minutes.Labels & decorationsMeet the thirteen labels, learn what each one means, and understand when a comment becomes blocking.

I'm setting it up for a repository

Your team is on board. Now you want everyone following the same rules.

ConfigureOne file on the default branch. Learn which settings matter, which gotchas to watch for, and how the three levels of configuration work together.Adoptionassist → warn → enforce. See what changes at each stage and how to roll back quickly if you need to.

I'm wondering what happens next

You want the convention applied consistently, regardless of who has installed what — and you're curious where enforcement is headed.

Enforce (roadmap)Why platform-level enforcement isn't shipped yet, what already works without it, and how the eventual implementation is being kept open.TroubleshootingUnderstand the banners and the few common surprises you're likely to run into the first time.

Reference

Stable references designed for tools as well as people.

  • The configuration schema is available at conventionalcomments.io/schema/v1.json. Add it to your file's $schema to get autocompletion and inline validation in your editor.
  • The Conventional Comments specification lives at conventionalcomments.org. This site provides independent tooling around it and does not define or represent the specification.
  • The source code is available under Apache-2.0 and includes the normative specification and the full set of acceptance criteria.