The real takeaway is that different projects have different requirements.<p>In over 30 years of using source control, I've never once worked on something where it's useful to include the component (article calls it scope) in the description in a standardised way. It's obvious what components are affected based on where in the source tree the affected files are. Similarly "bug", "fix" or "feature" adds no useful value. It's important or it wouldn't be checked in.<p>The only thing I've found useful, and which the article doesn't even consider, is a link / id for the relevant change request. The commit already contains all the information about what was done in the change, what's missing is the context about why.<p>Even on my solo projects I include a JIRA reference in square brackets before the description. If it's just something I randomly decided to fix during the course of development, I'll create a short 1 line JIRA to get an id and explain the why there.
Article is too opinionated IMO. I enforce CC on my projects because I don’t have the energy to police horrendous commit messages. It’s easy to enforce the CC format on the repo merge policy. I do it with the addition of a required issue ID as well.<p>If I only worked with seasoned devs, I wouldn’t use it, but that’s just the reality of my work. It also has a bonus of forcing AI agents to write in the same form as well instead of their random personal flavor. Precommit hooks stop everything before it gets in front of my eyes for review.
My main complaint with conventional commits always was that they don't include an issue number in the commit title. It's not even mentioned in their standards as optional or something.<p>To me this is almost the most important information in a commit message. I don't know how often in the last 15 years I was cross checking the issue description referenced by some old commit to get the full context of a change. I also felt that this habit is kind of standard - until i had to learn about "conventional commits".<p>I never got the hype.
I personally prefer including issues as git trailers:<p><pre><code> fix thing in foo
Issue: ABC-123
</code></pre>
Git has plenty of builtins for parsing and formatting these trailers, so you can easily create custom git log aliases that let you see them inline and parse them for use with CI.
Personally, if I am skimming a change log that is already limited in characters, I don’t care about ‘XYZ-999999’ in the main commit message. It’s good to tag as a trailer but I’d much rather see what the commit did than the Jira issue it came from.
Interesting, I guess we've been doing it wrong this whole time, as we do `fix(ABC-123): some message here`, which ends up being linked great, renders very nicely into the automated release notes, etc.
It isn't a standard, it is a <i>convention</i>. You can set a standard within your team to include the ticket id in the commit message.
IMO that is only a problem for those who demand that the issue key needs to go first in the subject (which again IMO is bad for readability). I don't see why you can't just stick it somewhere after all the conventional commits junk? Issue keys ought to be something that can be janked out based on a regex like an alphanumeric prefix followed by a number, so things like this "standard" have little need to set aside a space for it.<p>Personally (without conventional commits) I tend to put them at the end in parentheses if the commit has something to do with that issue. But if there is a stronger relationship like that it fixes the issue, I put a `Fixes` trailer in the message as well.
yeah this is the actual key. an actually useful title and a stable link to the discussion around the change.<p>conventional commits are pleasing, but questionable actual utility. the code speaks for itself. the actually useful information is a well chosen title and the context for the change.
Why do you even want the issue number in the commit <i>title</i>? I find that super annoying and unfortunately GitHub kind of forces it on you if you use merge queues.<p>It's fine for it to be in the description.
If i'm looking at git history, the ticket number is the most useful piece of info to get more context on the changes for me
It’s very helpful to know the motivation for the commit and if that motivation was tied to a client contract/feature. Especially in cases where a commit affects multiple files or even just one file so that all commits can be grouped into a feature/contract.
The use of the word "chore" in many users of conventional commits has always riled me. I've always tended to favour the "linux kernel"[0] style of commit subject, which thankfully gets a mention here.<p>[0] <a href="https://www.kernel.org/doc/html/v7.0/process/submitting-patches.html#the-canonical-patch-format" rel="nofollow">https://www.kernel.org/doc/html/v7.0/process/submitting-patc...</a>
Completely agree, the attitude implied by “chore” is very off-putting to me. As if the rest should all be marked “fun” or “indifferent”. That kind of emotional judgement doesn’t belong in a commit message.
I found an alternative word: "upkeep"<p>Same idea without the pejorative aspect.
You might enjoy Rich's take: <a href="https://richvdh.org/conventional-commits-considered-harmful.html#chore-is-a-problematic-term" rel="nofollow">https://richvdh.org/conventional-commits-considered-harmful....</a>
I'd much rather people think deeply about summarizing their work. This helps others understand it but, more importantly, helps the developer understand what they did. If its hard to summarize, maybe it should be tightened up a little for instance. Enforcing a "schema" might help a tiny bit but also can cause people to check out a little as it can feel like just another meaningless process.
I quite dislike this style of writing titles. "Stop something". I seems very popular. It sounds very commanding and "I am definitely right about this". Why not write "In favour of something" or "A case against something" or something like that?
Why not be direct and advocate clearly for the position that you prefer? You don’t have agree with their position, but asking them to water down their words is weak sauce.
Oh please. Public discussion is always a balance, and to answer your question: if the content is nuanced, the title should be too.
If they mismatch some of your audience is unnecessarily put off.<p>Ill add: I am personally put off in the same way your parent comment is, because hard stances are usually wrong, and I like a bit of nuance in my life.
Our interest in a statement is piqued more when it challenges our worldview. It's impolite to a lot of people, but the attention economy rewards it.
Not as bad as "considered harmful" imo but still mildly toxic. I think the point is taking one rando's personal preferences (I'd prefer we swap the order of A and B) and trying to make it sound like something more than it is.
I came to say something similar.<p>I don't like conventional commits much neither, but let the people use whatever they want!
Because you don't get attention if you don't write deliberately inflammatory content.
<a href="https://knowyourmeme.com/memes/stop-doing-math" rel="nofollow">https://knowyourmeme.com/memes/stop-doing-math</a><p>There is a meme that inspires some of this genre of title, fwiw
“The audience of a changelog is entirely different than the audience for a commit log!<p>A changelog is user-facing”<p>I'd say that ship has probably sailed. Most companies are happy with “Bug Fixes & Performance Improvements”.
At least if they're not going to put the effort in, then a generated changelog is better than nothing.
Odd. The main reason to use this style of commit message is for CI/CD automation.<p><i>EDIT: I didn't see this covered in the article on my first pass. It is covered though. My apologies.</i><p>The type of the commit informs the automated workflows how to handle the commit. This is why it comes first.<p>For example, if you're performing CD, if you only commit a bunch of `fix: ` then only your semantic versioning patch version number is incremented. If you commit a `feat: ` then it's a minor version is bump. `feat! ` is a major version bump.<p>Even if you're not using CD for releases, semantic commit messages are sometimes used to automate change log generation. Granted, your change logs should not typically include the Git commit messages themselves — those are developer facing, not user facing.
The article addresses both of these pretty clearly. Semantic versioning gets borked with reverts and the automatic changelog is targeting the wrong audience
My apologies, I missed this on first read due to the indentation style. That said, I don't agree on the commentary.<p>Why on Earth are people not writing commit messages for their reverts? They should have semantic commit messages just the same as any other commit.<p>Unless the point is that they're not following per-commit CD, and if you commit then revert that commit before a release was made. That sounds like a process failure. Which of course, process isn't infallible, and neither is the automated version management. If you screw up, use an escape hatch — just like reverting a commit that had previously gone through code review and been merged.<p>Re: change log generation. The article says change logs shouldn't have commit messages. I agree. Many tools (e.g. Changesets <a href="https://github.com/changesets/changesets" rel="nofollow">https://github.com/changesets/changesets</a>) use the semantic commit type to sort change log entries, but require you to write those user facing change log entries separately.
The article is wrong about reverts (in my opinion). If a breaking change is introduced, and then removed, the removal should also most likely be considered a breaking change (both the addition and removal are changing your API). So it is correct that a major version bump should occur when reverting. Once a package has been published, the ship has sailed.
The issue is that if there was no release in between, or only a beta or similar, you now have two breaking changes indicated by the commits, although in sum there is none since the last official release.
That's true, but depends on your workflow and release strategy.<p>If you are releasing upon every push to main/master (following what semantic release and conventional commits provides you in terms of automation), then it makes sense to perform major version bumps for the reverts.<p>If you have a manual release strategy, then it might not make sense to use these tools in the way they have been designed.
If you have actual dependents in a SemVer fashion, then this isn’t useful for those still on the prior version. What you’d rather do is decrement the major version again because it’s compatible with the prior version again. Those dependents who already upgraded to the interim version have to consider another breaking change regardless.<p>And if you don’t have these kinds of dependents, then the versioning scheme isn’t important anyway.
Use some convention for git trailers then. Having “fix” or “feat” in the commit title does not provide any useful information to someone scanning the log.
No no. You see we need to get rid of conventional commits so AI can make commits easier.
The thing conventional commits are really helpful for is continuous delivery. Every merge to main can be automatically tagged with semver and shipped because the thought that goes into tagging and versioning has already been done by the developers when they wrote the commit message.<p>I fully recognise that it doesn't make sense for huge projects like the Linux kernel to do this. But for 99% of projects conventional commits combined with semver vastly improves the release process status quo and makes it easy to automate.
I do this on my OSS projects to automate semver bumps and it's amazing! At work, I also enforce "tags" (not git tags, just strings in the PR title) based on who cares about the change and then generate changelogs for the respective teams based on those "tags".
The author's example of a conventional commit is not correct anyway IMO, which is maybe why they think the "fix" part is redundant:<p>> fix: prevent foo from bar'ing<p>The whole idea of conventional commit is:<p>> fix: [problem]<p>so the correct conventional commit would be:<p>> fix: foo bar'ing<p>which is succinct and perfectly fine.
Whole idea of CC is to write commits in away that is easy to generate change logs. If you utilize CC correctly or not, at best you get: commit log that harder to read, changelog that is hard to read and still requires you to write highlights (guess minor and path releases are fine).
What you describe doesn’t match <<a href="https://www.conventionalcommits.org/en/v1.0.0/" rel="nofollow">https://www.conventionalcommits.org/en/v1.0.0/</a>>’s examples, or any practice I’ve ever seen.<p>> fix: prevent racing of requests<p>Though the example in the actual specification, “fix: array parsing issue when multiple spaces were contained in string”, is more inconclusive (and frankly doesn’t really make sense as a <i>description</i>).
yep. I'm on the fence about types generally, but "fix:" saves/standardizes a bunch of phrases like "fix an issue where", "prevent" or having to invert the message by describing the solution instead.
Want machine-readable? Use the footers/trailers.<p>I can not say anything nice about conventional commits. The format takes up space in the most-read part of the message. The categories or types have little information. They can be replaced with an honest English verb embedded in the subject like a sentence. It also reads way better with just a sentence instead of three kinds of punctuation (:, (), !). Okay, I can tolerate an "area" in the subject. And that predates this conventio.<p>At my dayjob we make a webapp for non technical people. I can write a changelog for that just fine (in norwegian). The commit messages are irrelevant to the users. And demanding that all commits should be good enough for an end-user changelog? That's not happening for us anytime soon.<p>Use footers/trailers instead.
I think any notation is use case specific and should be adapted to beat serve its domain.<p>However, actually writing a good commit message is an art form few have mastered.<p>I wrote a small natural language linter to teach my teams meaningful technical writing:
<a href="https://github.com/codingjoe/word-weasel" rel="nofollow">https://github.com/codingjoe/word-weasel</a>
I see more of these conventional commit-style comments recently and it feels like coming from Claude Code etc. It's a bit unsettling that not only training data but also random lines in the default system prompt affects this kind of software development norms in subtle and pervasive ways.
As a solo developer, I rarely struggle to remember what changed yesterday. I often struggle to remember why I made a decision six months ago.<p>Conventional commits are most valuable to me as historical context rather than as a release-management tool.<p>The larger the project becomes, the more useful that context gets.
This sounds like what regular commit messages do. How are conventional commits specifically helpful?
That information should still be in the commit messages. "No functional change intended." appears widely in FreeBSD commit logs when code is being refactored (or, rarely, restyled).<p>And the issue isn't whether <i>you</i> can remember what you changed yesterday; this is largely about making sure <i>other developers</i> can quickly identify relevant commits. If you're a solo non-OSS developer, this is entirely relevant to you.
I have never been involved in a project where people make good commits. Having a convention at least forces people to make thoughtful one-liners.
There’s a much less awkward way to keep a change log:<p>Keep a change log.
This is not without struggles. Many times the changelog updates are missed. You can try to catch this in code review, but that could also be missed. So you can try to automatically verify the changelog was updated, but you can't force that as a pass/fail check since not all changes require a user facing change. Or your project maintainers simply copy the commit message and paste it into the changelog, and at that point, why not just automate it with something like conventional commits?<p>Could/should the changelog be considered a first-class deliverable with care and attention provided? I think so, but I'm not in a position to exert direct control over that across dozens of repos and team members.
> <i>Many times the changelog updates are missed.</i><p>In my experience, LLMs are great at reviewing changelogs for potential gaps from a user POV (and even creating draft changelogs wholesale, if you're backfilling) based on git history.
I 100% agree. I found <a href="https://keepachangelog.com/en/1.1.0/" rel="nofollow">https://keepachangelog.com/en/1.1.0/</a> as I was writing the article which advocates for exactly this!
Definitely agree that generating change logs from commits leads to confusing change logs for people that expect to see what changed between versions. A big long list of commits is too granular. A curated and summarized list of changes is much more in-line with what most people expect when reading a change log.
I totally agree.<p>If one needs to put metadata in commits, usually better to just put it in a Git trailer.<p><a href="https://git-scm.com/docs/git-interpret-trailers" rel="nofollow">https://git-scm.com/docs/git-interpret-trailers</a><p>`Co-authored-by: Alice` is a common one, but you can have anything in there.
I think some structure in commit messages is helpful, but not to the point where it gets in the way of effectively reflecting what the commit contains, why it was done, and any comments for future reference, e.g. potential regressions.
I have long despised Conventional Commits for pretty much these reasons. Yes, it’s structure, but it’s not <i>useful</i> structure. Of the five things it claims to enable, three are nonsense and the other two are actively <i>bad</i>.<p>And it’s ugly.<p>(But I suppose I am talking primarily about the first line part. The “BREAKING CHANGE” bit is potentially actually useful, though being incompatible with git-interpret-trailers despite leaning on git-interpret-trailers for <i>other</i> footers seems a bit crazy.)
This entire essay is just about how it should be "<scope> <optional type>" instead of "<type> <optional scope>"?
Couldn't agree more with this. The commit type tells me almost nothing and just wastes my time skipping over it. Scopes are way more useful.
Asides from the well made points here ('scope is more important than type' etc).<p>> something like fix, feat, chore, docs, or refactor<p>'Docs' are also part of the program, they need fixes too, and features need docs. If the docs don't match the features because they're not being updated when the code is, the docs are a lie and waste other developers time.<p>Also if you were writing a standard: why would you randomly abbreviate 'feature' but not 'refactor'? That sounds like a nitpick but standards require great thought, this is a bit of a smell that there hasn't been much thought into designing 'conventional commits'.<p>Finally: the name 'Conventional commits' is a land grab (reminds me of when someone made a JS Standard and called it 'StandardJS', ignoring every existing popular standard). From the article, the *actual* convention is 'scope: work"<p>- Linux<p><pre><code> subsystem: description
</code></pre>
- FreeBSD<p><pre><code> prefix: description
</code></pre>
- Git<p><pre><code> area: description
</code></pre>
- Go<p><pre><code> package: description
</code></pre>
- nixpkgs<p><pre><code> pkg-name: description</code></pre>
And then you have me, using gitmoji
Mine is “ticket id - Imperative phrase”. Then I write a “why” description of the changes if needs be. As for personal project, I quite like the scoped commits style.
terrible suggestion, people are awful at writing commit messages and the type is really helpful when you're reviewing history and want to know things at a glance
I don't care much what it says as in "fix", "chore" etc, but for me the main benefit is breaking changes indicated with "<type>!", something like "feat!: ...
".<p>This makes neovim plugin manager highlight the change differently which brings attention to it when you update stuff.<p>So please do use it instead of complaining!<p>I do like the suggestion of<p>scope!: ...<p>if it will be treated the same way with breaking changes reactions.
[dead]
dumb take, next
I really dont care about commit messages. Just create strict rules for branches that contains issue nr + description, and squash all commits on merging the PR.