Conventional Commits

Conventional Commits

Conventional Commits is a specification for adding human and machine readable meaning to commit messages. This allows automate the release process and generate changelogs.


Each commit message prefix is a type of change, examples:

  • feat: add support for Typescript
  • fix(gha): release workflow missing secret
  • docs: add docs for account service
  • chore: update dependencies
  • refactor: extract method convertImage

Can recommend the action-semantic-pull-request GitHub Action to enforce this convention for pull requests titles.

This can be enforced for every PR in a GitHub org by using Required Workflows.