Skip to main content
Write commit messages and pull request titles in the Conventional Commits format.
CI checks every pull request title. If it fails, edit the title and the check runs again. Commit messages aren’t checked, but use the same format.

Allowed types

The list comes from .github/workflows/pr-naming-conventions.yml.

Tips

  • Use lowercase and the imperative mood: “add feature”, not “added feature”.
  • Keep the first line short.
  • Mark breaking changes with ! or a BREAKING CHANGE: footer.
  • Put the why in the body, and link issues with Closes #123.
release-please reads the merged history to bump versions, write changelogs, and open release pull requests.