fix: simplify conventional commits #297
Merged
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
Mossman1215
requested changes
Aug 8, 2024
There was a problem hiding this comment.
needs updates to the readme to match
https://github.com/GeoNet/Actions/blob/main/README.md?plain=1#L672
MCorfy
force-pushed
the
simple-convention-commits
branch
from
65c04fb to
3f1b79b
Compare
Replace all conventional commits with feat, fix and nfc
MCorfy
force-pushed
the
simple-convention-commits
branch
from
3f1b79b to
5cb9dca
Compare
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.
Our conventional commits are all over the place. Everyone uses different commit types and there are too many types that overlap. This significantly reduces the usefulness of conventional commits.
This PR aims to address this by radically simplifying the conventional commits to use three types:
feat:
New stuff, features.
fix:
Fixing broken stuff, correcting stuff, small improvements etc.
nfc:
Non-functional-change. Documentation, code comments, refactoring, style changes etc. Stuff that doesnt DO anything.
NFC changes are easy to review.
It's much easier to pick one of these three categories for your commits than picking between the 10 types we have now.
I've used this format in a previous job and it works well.