chore: Add PR title conventional commit format check #985
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do?
Motivation
squash and merge
pattern, our PR titles become the git commit description which is populated in the GitHub release log. Currently, we don't format our releases for conventional commits, but with this new workflow, we can ensure that PR titles follow conventional commits and better generate both the release name and release notesExample of conventional commit title:
feat: Add support for 'foo' addon
Example of NOT conventional commit title:
add Support for FOO addon
More
pre-commit run -a
with this PRNote: Not all the PRs require a new example and/or doc page. In general:
docs/add-ons/*
is required for new a new addonFor Moderators
Additional Notes