feat: use semver.org as a basis for conventionalcommits.org #2
Conversation
|
Also cc @btford @vojtajina @pkozlowski-opensource @pdehaan @petebacondarwin @mhevery @IgorMinar (early developers of conventional-changelog) |
|
FYI I recently wrote a new changelog generator: github.com/petebacondarwin/changez |
|
@bcoe I think the type vs. body|footer clarifications in the spec were quite helpful |
I'll update the Unleash docs as soon as were ready here @bcoe |
|
@jameswomack which part do you think needs clarification (regarding type, vs., body, vs. footer) mind perhaps taking a stab at the copy. |
|
I ended up just paying for a $7 dyno on Heroku, and getting a free Let's Encrypt certificate (this sort of thing is a lot easier than it used to be apparently). https://conventionalcommits.org/ Is up, but let's not advertise it to anyone until we do a few rounds of editing on this site. |
|
|
||
| <h2 id="whos-behind-thisinspired-this">Who’s Behind This/Inspired This?</h2> | ||
|
|
||
| <p>The Conventional Commit standard is inspired by the <a href="https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#commit">Angular Commit Guidelines</a>, which |
There was a problem hiding this comment.
Can we link https://github.com/angular/angular/blob/master/CONTRIBUTING.md#commit instead? It's more up to date
There was a problem hiding this comment.
👍 feel free to submit a patch with this; otherwise I'll do it after the work day today.
| A scope may be provided to a commit’s type, to provide additional contextual information and | ||
| is contained within parenthesis, e.g., <code class="highlighter-rouge">feat(parser): adds ability to parse arrays</code>.</p> | ||
|
|
||
| <p>Commit <em>types</em> other than <code class="highlighter-rouge">fix:</code> and <code class="highlighter-rouge">feat:</code> are allowed, for example <a href="https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#commit-message-format">the angular convention</a> recommends <code class="highlighter-rouge">docs:</code>, <code class="highlighter-rouge">style:</code>, <code class="highlighter-rouge">refactor:</code>, <code class="highlighter-rouge">perf:</code>, <code class="highlighter-rouge">test:</code>, <code class="highlighter-rouge">chore:</code>, but these tags are |
There was a problem hiding this comment.
Same here.
Also should we use "Angular" instead of "angular" throughout the site?
There was a problem hiding this comment.
@stevemao sounds good 👍 I will loop back through and fix this.
|
@bcoe I'm not sure if it's fair to pay everything from your own pocket? How do other sites like semver.org work? |
|
@petebacondarwin Just curious if the Angular team would be interested in this project? EG: pointing Commit Message Guidelines in your docs to this site instead of this Google docs. The site should cover all the information in your docs. I'm not sure why you created another changelog generator, but if conventional-changelog doesn't do what you expect, let us know. I want to echo myself that this project was actually first started by your team so this should still serve you guys. We want to offload your work of changelog generation and maintaining Commit Message Guidelines :) |
|
Oh, we should probably mention commitizen, which is a very popular tool to generate conventional commits. cc @LinusU @jimthedev @kentcdodds |
|
@stevemao @bcoe Hi and thanks for including us. One thing to note about commitizen is that we are a tool to commit but also have userland adapters which basically allows the maintainer to decide what style of commit messages their CI requires / expects. Adapters allow people to define their own prompts that commiters will see when doing a commit in that repo. Most* people use the cz-conventional-changelog adapter. It basically follows the original angular commit style. With that said, there are adapters that use emoji, Jira smart commit formatting and other internal styles for commit messages. This means that although much of the tooling relies upon you using cz-conventional-changelog and the angular style of conventional commits, not all do. You can look for commitizen adapters and probably get a pretty good idea of the various ways people are styling their commits outside of conventional commits. If you only really care about the cz-conventional-changelog/angular style then check out https://github.com/commitizen/cz-conventional-changelog. The hardest part has been that I'd love to add metadata into the spec so that we could allow people to use their own convention/adapter but still be able to label intent behind a given field. This would still let us parse out the intent behind it while allowing some level of customization. The trouble is that as you add more markup, the less likely it is possible for those not using tools to be able to contribute by hand using regular git commit. We've walked a fine line by basically saying that you can have the flexibility of commitizen but you're on your own when it comes to integrating with tools like semantic-release or others if you use anything other than cz-conventional-changelog / angular. |
|
@jimthedev I hear where you're coming from ... a big part of why I think "Conventional Commits" should be a trimmed down version of the angular convention, is to leave more room for flexibility., e.g., we only really care about:
Any thoughts about edits, wording changes, compromises, etc., we could make that would better suit your use-case? |
Using semver.org as a jumping off point, @jameswomack and I sat down this weekend and took a stab at some of the initial content for conventionalcommits.org (which I've bought the domain name for).
Here's what I think the next steps are:
./index.md.conventional-changelog.github.ioURL I believe (I think some sites like CloudFlare assume you are using this canonical address).--conventional-commitsflag we added to lerna?, and @jameswomack perhaps you could update unleash's docs?).I'm excited about this spec! I think we're putting a flag in the ground for the community, and regardless of the release management tool people use, this will help encourage more standardization between projects.
Look forward to feedback, CC: @JaKXz, @evocateur, @Tapppi, @stevemao, @jameswomack, @boennemann, @ajoslin.