mirror of
https://github.com/conventional-commits/conventionalcommits.org.git
synced 2026-03-12 02:17:21 -05:00
conventionalcommits.org, a website that introduces people to the concept of conventional commits #1
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 @bcoe on GitHub (Mar 31, 2017).
This post may be somewhat controversial, being Canadian I'm prefacing the whole thing with an apology 🍁
What's is conventional-changelog?
The conventional-changelog organization is a set of modules for parsing various flavors of commit message formats (angular, atom, jquery, ...), and performing useful operations based on this meta-information:
Despite conventional-changelog's abstract design, many of the tools related to the conventional-changelog ecosystem are adopting the angular commit convention:
The Value of Conventional Commits
When evangelizing adopting a conventional commit format to people, there are a few things I emphasize:
bit more than I usually would and come up with a useful commit message -- this makes for a much more useful commit history in general.
BREAKING CHANGE,fix,feat), you become able to programmatically determine what the version bump for the next release should be.perhaps most importantly!
I emphasize that it doesn't add much work:
semantic-release,standard-version,lerna, etc., to automatethings.
Avoiding a Paradox of Choice
I found a few things confusing when introduced to the
conventional-changelogecosystem and the concept of the angular commit convention:conventional-changelogshould be more prescriptive; It's great to have flexible core libraries, but as a user I was mainly interested in: eliminating tedium around version bumps, and CHANGELOG management,I wanted a happy path that introduced me to the concept of conventional commits.
conventional-changelog,semantic-release,angular, etc.Proposal
I really like the semver.org specification. It introduces the concept of semantic
versioning in a clear, tool agnostic way, explaining its value to the software development process.
I propose that for the
conventional-changelog.github.iowebsite, we put up a site modeled after semver.org -- potentially hosted at conventionalcommits.org:commits to your project.
conventional-commits: it has wide adoption, it's simple, and seems like a great format to standardize on.semantic-release, lerna, standard-version, but let's not make the website focus on the
conventional-changelog project itself.
Help Wanted!
How do folks feel about this proposal? I would love help pulling together documentation
for conventionalcommit.org; I think it will be a great place for us to point our various users to.
I reached out to @mojombo, he'd happily let us use the design from the semver.org website as
a jumping off point for our specification; @JaKXz also indicated that he'd be excited to help us setup a scaffolding using fancy pants new web technologies.
CC: @ajoslin, @stevemao, @Tapppi, @evocateur, @boennemann
@evocateur commented on GitHub (Mar 31, 2017):
I also like the example of http://keepachangelog.com/. I think this would be a great idea for
conventional-commits+ friends.@bcoe commented on GitHub (Apr 1, 2017):
I'm looping in @jameswomack as well, who works on unleash; a cool release management tool that also adheres to the angular commit standards.