Enforce conventional commit messages #236
Description
Conventional commits give engineers clear guidance on how commit messages should be written. This helps reviewers understand the work contained within a PR. Additionally it lays the ground work for moving to an automated release system whereby version numbers can be generated based on contents of commit messages. We can also generate changelog files when commits are structured in this way.
Benefits: https://www.conventionalcommits.org/en/v1.0.0-beta.2/#why-use-conventional-commits
In order for this to work we will need to provide tooling that checks commit messages on commit but more importantly when we perform the squash merge in GitHub.
Tools:
- https://github.com/conventional-changelog/commitlint/
- https://github.com/wagoid/commitlint-github-action
- Merge queues can be used to lint the squash commit message: https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue