mirror of
https://github.com/conventional-commits/conventionalcommits.org.git
synced 2026-05-23 06:10:51 -05:00
I don't want to read #169
No Assignees
Notifications
Due Date
No due date set.
Dependencies
No dependencies set.
Reference: github-starred/conventionalcommits.org#169
Reference in New Issue
Block a user
Delete Branch "%!s()"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
Originally created by @gswallow on GitHub (Mar 17, 2023).
Create a chart rather than paragraphs of blah blah blah that I'm not going to read.
Tell me which words to use in my commit messages, without using too many words.
@TristanCottam commented on GitHub (Apr 15, 2023):
While the specification itself is reasonable in length, I do like infographics (everyone does — it only encourages adoption), and the types recommended by @commitlint/config-conventiona aren't included in the specification itself (which I think they should, despite being less important than
fixandfeat), and aren't even described at all (which I also endorse). Also, the specification itself should be more prominent on the website; it should precede the examples at the very least.+1 for that priceless title
@quadespresso commented on GitHub (Jun 8, 2023):
The spec could be left as-is, but I'm with @gswallow in wanting a chart, or at least something in tabular format. It could be in addition to, rather than a replacement for the spec.
I'm also a fan of infographics, although I'm trying to imagine what an infographic version of the spec would look like. A table is something I can paste locally (Markdown), even selectively. It could be a nice bit of copypasta to include in the hidden section of my/your repo's
pull_request_template.mdfile.@mentalisttraceur commented on GitHub (Aug 23, 2023):
The whole table is just:
fixfeatMaybe also:
fix!feat!BREAKING CHANGEgoes at the bottom.Conventional Commits does not define any other words to use in our commits. It leaves the option to use other words so long as you stick to the format, and refers to one common convention as an example.
@paul-uz commented on GitHub (Aug 25, 2023):
https://dev.to/hornet_daemon/git-commit-patterns-5dm7
@gswallow commented on GitHub (Aug 25, 2023):
I was grumpy; I apologize for that.
I found a very helpful cheat sheet that I refer to:
https://cheatography.com/albelop/cheat-sheets/conventional-commits/
@mentalisttraceur commented on GitHub (Aug 25, 2023):
@gswallow great cheat sheet, thanks for sharing!
I would've gotten grumpy too. I think most of us come in thinking that "Conventional Commits" defines many commit types. If I was just trying to learn what those are so that I could get stuff done, I would've been equally frustrated.
@damianopetrungaro commented on GitHub (Sep 2, 2023):
I think adding a tiny chart to help digesting the spec would be helpful.
That's something we could add quite easily to the spec without any versioning changes.
Anyone in this issue wants to create a PR?
cc @bcoe
@bcoe commented on GitHub (Nov 21, 2023):
@damianopetrungaro I agree, at work I try to distill conventional commits down to fundamentals when explaining it to people, i.e., most people only care about
feat,fix, and occasionally breaking changes.I'm an awful artist, do any contributors reading this thread have an idea for what a chart should look like?
@damianopetrungaro commented on GitHub (Nov 21, 2023):
@mentalisttraceur @gswallow @quadespresso if any of you know a designer (or you are good with it as well!), we're open to this idea.
Let me know!
@gustavo-alberto commented on GitHub (Apr 2, 2024):
Maybe we should try to implement a dynamically generated cheat sheet that get data based on the language and generates a pdf in a friendly printing format. I'm working on some sketches on figma...