feat(GHA): adding conventional commit linting #133
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Adding a new github action step as linting for commit messages. Lots of OS repositories seem to have adopted the [conventional commit style] (https://www.conventionalcommits.org/en/v1.0.0/#summary). This PR is a simple check on the commit message, giving the commiter feedback on the commit message style. This could be complemented by a precommit check if we revisit it.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Using a PR to kick off a conversation about conventional commit styles
and whether we should use it for turbolift.
I've been using it and seen it used here and there on many open source
repositories and seems to be wide spread.
Change
Adding a new github action step as linting for commit messages.
What will the commit message look like?
From the documentation, they will follow this convention:
Where type can be:
fix(typically a bug fix)feat(a new feature)chore(for engineering health)refactorand many more.A typical commit message would look like:
Why?
Lots of OS repositories seem to have adopted the [conventional commit
style] (https://www.conventionalcommits.org/en/v1.0.0/#summary).
This PR is a simple check on the commit message, giving the commiter
feedback on the commit message style.
This could be complemented by a precommit check if we revisit it.