From 8a2472ca9103a2820973670856d216384908e7d2 Mon Sep 17 00:00:00 2001 From: Benjamin Coe Date: Tue, 13 Aug 2019 18:09:13 -0700 Subject: [PATCH 1/6] chore: release 1.0 of specification --- _redirects | 2 +- content/next/index.md | 2 +- content/v1.0.0/index.md | 200 ++++++++++++++++++++++++++++++++++++++++ 3 files changed, 202 insertions(+), 2 deletions(-) create mode 100644 content/v1.0.0/index.md diff --git a/_redirects b/_redirects index fb8dbf72..ffb1eff2 100644 --- a/_redirects +++ b/_redirects @@ -1 +1 @@ -/ /en/v1.0.0-beta.4/ +/ /en/v1.0.0/ diff --git a/content/next/index.md b/content/next/index.md index 1fcd1b99..12016aaa 100644 --- a/content/next/index.md +++ b/content/next/index.md @@ -2,7 +2,7 @@ draft: true --- -# Conventional Commits 1.0.0 +# Conventional Commits 1.0.0.next ## Summary diff --git a/content/v1.0.0/index.md b/content/v1.0.0/index.md new file mode 100644 index 00000000..8303a6a4 --- /dev/null +++ b/content/v1.0.0/index.md @@ -0,0 +1,200 @@ +--- +draft: false +aliases: ["/en/"] +--- + +# Conventional Commits 1.0.0 + +## Summary + +The Conventional Commits specification is a lightweight convention on top of commit messages. +It provides an easy set of rules for creating an explicit commit history; +which makes it easier to write automated tools on top of. +This convention dovetails with [SemVer](http://semver.org), +by describing the features, fixes, and breaking changes made in commit messages. + +The commit message should be structured as follows: + +--- + +``` +[optional scope]: + +[optional body] + +[optional footer] +``` +--- + +
+The commit contains the following structural elements, to communicate intent to the +consumers of your library: + +1. **fix:** a commit of the _type_ `fix` patches a bug in your codebase (this correlates with [`PATCH`](http://semver.org/#summary) in semantic versioning). +1. **feat:** a commit of the _type_ `feat` introduces a new feature to the codebase (this correlates with [`MINOR`](http://semver.org/#summary) in semantic versioning). +1. **BREAKING CHANGE:** a commit that has the text `BREAKING CHANGE:` at the beginning of its optional body or footer section introduces a breaking API change (correlating with [`MAJOR`](http://semver.org/#summary) in semantic versioning). +A BREAKING CHANGE can be part of commits of any _type_. +1. Others: commit _types_ other than `fix:` and `feat:` are allowed, for example [@commitlint/config-conventional](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional) (based on the [the Angular convention](https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#-commit-message-guidelines)) recommends `chore:`, `docs:`, `style:`, `refactor:`, `perf:`, `test:`, and others. + +We also recommend `improvement` for commits that improve a current implementation without adding a new feature or fixing a bug. +Notice these types are not mandated by the conventional commits specification, and have no implicit effect in semantic versioning (unless they include a BREAKING CHANGE). +
+A scope may be provided to a commit's type, to provide additional contextual information and is contained within parenthesis, e.g., `feat(parser): add ability to parse arrays`. + +## Examples + +### Commit message with description and breaking change in body +``` +feat: allow provided config object to extend other configs + +BREAKING CHANGE: `extends` key in config file is now used for extending other config files +``` + +### Commit message with `!` to draw attention to breaking change +``` +chore!: drop Node 6 from testing matrix +``` + +### Commit message with both `!` and BREAKING CHANGE in body +``` +chore!: drop Node 6 from testing matrix + +BREAKING CHANGE: dropping Node 6 as it hits end of life in April +``` + +### Commit message with no body +``` +docs: correct spelling of CHANGELOG +``` + +### Commit message with scope +``` +feat(lang): add polish language +``` + +### Commit message for a fix using an (optional) issue number. +``` +fix: correct minor typos in code + +see the issue for details on the typos fixed + +closes issue #12 +``` + +## Specification + +The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in [RFC 2119](https://www.ietf.org/rfc/rfc2119.txt). + +1. Commits MUST be prefixed with a type, which consists of a noun, `feat`, `fix`, etc., followed + by an OPTIONAL scope, and a REQUIRED terminal colon and space. +1. The type `feat` MUST be used when a commit adds a new feature to your application or library. +1. The type `fix` MUST be used when a commit represents a bug fix for your application. +1. A scope MAY be provided after a type. A scope MUST consist of a noun describing a + section of the codebase surrounded by parenthesis, e.g., `fix(parser):` +1. A description MUST immediately follow the space after the type/scope prefix. +The description is a short summary of the code changes, e.g., _fix: array parsing issue when multiple spaces were contained in string._ +1. A longer commit body MAY be provided after the short description, providing additional contextual information about the code changes. The body MUST begin one blank line after the description. +1. A footer of one or more lines MAY be provided one blank line after the body. The footer MUST contain meta-information +about the commit, e.g., related pull-requests, reviewers, breaking changes, with one piece of meta-information +per-line. +1. Breaking changes MUST be indicated in the type/scope prefix of a commit, or at the beginning of its optional body or footer section. +1. If included in the body or footer, a breaking change MUST consist of the uppercase text BREAKING CHANGE, followed by a colon, space, and description, e.g., +_BREAKING CHANGE: environment variables now take precedence over config files._ +1. If included in the type/scope prefix, breaking changes MUST be indicated by a +`!` immediately before the `:`. If `!` is used, `BREAKING CHANGE:` MAY be ommitted from the +body or footer section, and the commit description SHALL be used to describe the breaking change. +1. Types other than `feat` and `fix` MAY be used in your commit messages. +1. The units of information that make up conventional commits MUST NOT be treated as case sensitive by implementors, with the exception of BREAKING CHANGE which MUST be uppercase. + +## Why Use Conventional Commits + +* Automatically generating CHANGELOGs. +* Automatically determining a semantic version bump (based on the types of commits landed). +* Communicating the nature of changes to teammates, the public, and other stakeholders. +* Triggering build and publish processes. +* Making it easier for people to contribute to your projects, by allowing them to explore + a more structured commit history. + +## FAQ + +### How should I deal with commit messages in the initial development phase? + +We recommend that you proceed as if you've already released the product. Typically *somebody*, even if it's your fellow software developers, is using your software. They'll want to know what's fixed, what breaks etc. + +### Are the types in the commit title uppercase or lowercase? + +Any casing may be used, but it's best to be consistent. + +### What do I do if the commit conforms to more than one of the commit types? + +Go back and make multiple commits whenever possible. Part of the benefit of Conventional Commits is its ability to drive us to make more organized commits and PRs. + +### Doesn’t this discourage rapid development and fast iteration? + +It discourages moving fast in a disorganized way. It helps you be able to move fast long term across multiple projects with varied contributors. + +### Might Conventional Commits lead developers to limit the type of commits they make because they'll be thinking in the types provided? + +Conventional Commits encourages us to make more of certain types of commits such as fixes. Other than that, the flexibility of Conventional Commits allows your team to come up with their own types and change those types over time. + +### How does this relate to SemVer? + +`fix` type commits should be translated to `PATCH` releases. `feat` type commits should be translated to `MINOR` releases. Commits with `BREAKING CHANGE` in the commits, regardless of type, should be translated to `MAJOR` releases. + +### How should I version my extensions to the Conventional Commits Specification, e.g. `@jameswomack/conventional-commit-spec`? + +We recommend using SemVer to release your own extensions to this specification (and +encourage you to make these extensions!) + +### What do I do if I accidentally use the wrong commit type? + +#### When you used a type that's of the spec but not the correct type, e.g. `fix` instead of `feat` + +Prior to merging or releasing the mistake, we recommend using `git rebase -i` to edit the commit history. After release, the cleanup will be different according to what tools and processes you use. + +#### When you used a type *not* of the spec, e.g. `feet` instead of `feat` + +In a worst case scenario, it's not the end of the world if a commit lands that does not meet the conventional commit specification. It simply means that commit will be missed by tools that are based on the spec. + +### Do all my contributors need to use the conventional commit specification? + +No! If you use a squash based workflow on Git lead maintainers can clean up the commit messages as they're merged—adding no workload to casual committers. +A common workflow for this is to have your git system automatically squash commits from a pull request and present a form for the lead maintainer to enter the proper git commit message for the merge. + +## About + +The Conventional Commit specification is inspired by, and based heavily on, the [Angular Commit Guidelines](https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#-commit-message-guidelines). + +The first draft of this specification has been written in collaboration with some of the folks contributing to: + +* [conventional-changelog](https://github.com/conventional-changelog/conventional-changelog): a set of tools for parsing conventional commit messages from git histories. +* [bumped](https://bumped.github.io): a tool for releasing software that makes it easy to perform actions before and after releasing a new version of your software. +* [unleash](https://github.com/netflix/unleash): a tool for automating the software release and publishing lifecycle. +* [lerna](https://github.com/lerna/lerna): a tool for managing monorepos, which grew out of the Babel project. + +## Tooling for Conventional Commits + +* [fastlane-plugin](https://github.com/xotahal/fastlane-plugin-semantic_release): follows the specification to manage versions and generate a changelog automatically +* [php-commitizen](https://github.com/damianopetrungaro/php-commitizen): a tool built to create commit messages following the Conventional Commit specs. +Configurable and usable for PHP projects as a composer dependency or usable globally for non-PHP projects. +* [conform](https://github.com/autonomy/conform): a tool that can be used to enforce policies on git repositories, including conventional commits. +* [standard-version](https://github.com/conventional-changelog/standard-version): Automatic versioning and CHANGELOG management, using GitHub's new squash button and the recommended Conventional Commits workflow. +* [Git Commit Template](https://plugins.jetbrains.com/plugin/9861-git-commit-template): Add _Conventional Commits_ support to [JetBrains Editors](https://www.jetbrains.com/) (IntelliJ IDEA, PyCharm, PhpStorm...). + +## Projects Using Conventional Commits + +* [Blaze UI](https://github.com/BlazeUI/blaze): Framework-free open source UI toolkit. +* [electron](https://github.com/electron/electron): Build cross-platform desktop apps with JavaScript, HTML, and CSS. +* [istanbuljs](https://github.com/istanbuljs/istanbuljs): a collection of open-source tools and libraries for adding test coverage to your JavaScript tests. +* [massive.js](https://github.com/dmfay/massive-js): A data access library for Node and PostgreSQL. +* [mhy](https://mhy.js.org): A zero-config, out-of-the-box, multi-purpose toolbox and development environment. +* [Monica](https://github.com/monicahq/monica): An open source personal relationship management system. +* [scroll-utility](https://github.com/LeDDGroup/scroll-utility): A simple to use scroll utility package for centering elements, and smooth animations +* [uPortal-home](https://github.com/UW-Madison-DoIT/angularjs-portal) and [uPortal-application-framework](https://github.com/UW-Madison-DoIT/uw-frame): Optional supplemental user interface enhancing [Apereo uPortal](https://www.apereo.org/projects/uportal). +* [yargs](https://github.com/yargs/yargs): everyone's favorite pirate themed command line argument parser. +* [yii2-basic-firestarter](https://github.com/HunWalk/yii2-basic-firestarter): 🔥 An enhanced Yii2 app template. +* [@thi.ng/umbrella](https://github.com/thi-ng/umbrella): Monorepo of ~100 TypeScript projects for data driven development + +[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org) + +_want your project on this list?_ [send a pull request](https://github.com/conventional-changelog/conventionalcommits.org/pulls). From 41f517695b673869c3f5e8b5d4dbebb317e748ab Mon Sep 17 00:00:00 2001 From: bcoe Date: Fri, 6 Sep 2019 19:20:12 -0700 Subject: [PATCH 2/6] chore: update v1.0.0 doc --- content/next/index.md | 20 +++++++++- content/v1.0.0/index.md | 88 +++++++++++++++++++++++++++-------------- 2 files changed, 77 insertions(+), 31 deletions(-) diff --git a/content/next/index.md b/content/next/index.md index 12016aaa..92a8a160 100644 --- a/content/next/index.md +++ b/content/next/index.md @@ -2,7 +2,7 @@ draft: true --- -# Conventional Commits 1.0.0.next +# Conventional Commits 1.0.1 ## Summary @@ -172,6 +172,22 @@ In a worst case scenario, it's not the end of the world if a commit lands that d No! If you use a squash based workflow on Git lead maintainers can clean up the commit messages as they're merged—adding no workload to casual committers. A common workflow for this is to have your git system automatically squash commits from a pull request and present a form for the lead maintainer to enter the proper git commit message for the merge. +### How does Conventional Commits handle revert commits? + +Reverting code can be complicated: are you reverting multiple commits? if you revert a feature, should the next release +instead be a patch? + +Conventional Commits does not make an explicit effort to define revert behavior. Instead we leave it to tooling +authors to use the flexility of _types_ and _footers_ to develop their logic for handling reverts. + +One recommendation is to use the `revert` type, and a footer that references the commit SHAs that are being reverted: + +``` +revert: let us never again speak of the noodle incident + +Refs: #676104e, #a215868 +``` + ## About The Conventional Commit specification is inspired by, and based heavily on, the [Angular Commit Guidelines](https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#-commit-message-guidelines). @@ -210,4 +226,4 @@ Configurable and usable for PHP projects as a composer dependency or usable glob [![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org) -_want your project on this list?_ [send a pull request](https://github.com/conventional-changelog/conventionalcommits.org/pulls). +_want your project on this list?_ [send a pull request](https://github.com/conventional-changelog/conventionalcommits.org/pulls). \ No newline at end of file diff --git a/content/v1.0.0/index.md b/content/v1.0.0/index.md index 8303a6a4..d7c6a15b 100644 --- a/content/v1.0.0/index.md +++ b/content/v1.0.0/index.md @@ -22,7 +22,7 @@ The commit message should be structured as follows: [optional body] -[optional footer] +[optional footer(s)] ``` --- @@ -32,18 +32,19 @@ consumers of your library: 1. **fix:** a commit of the _type_ `fix` patches a bug in your codebase (this correlates with [`PATCH`](http://semver.org/#summary) in semantic versioning). 1. **feat:** a commit of the _type_ `feat` introduces a new feature to the codebase (this correlates with [`MINOR`](http://semver.org/#summary) in semantic versioning). -1. **BREAKING CHANGE:** a commit that has the text `BREAKING CHANGE:` at the beginning of its optional body or footer section introduces a breaking API change (correlating with [`MAJOR`](http://semver.org/#summary) in semantic versioning). +1. **BREAKING CHANGE:** a commit that has a footer `BREAKING CHANGE:`, or appends a `!` after the type/scope, introduces a breaking API change (correlating with [`MAJOR`](http://semver.org/#summary) in semantic versioning). A BREAKING CHANGE can be part of commits of any _type_. -1. Others: commit _types_ other than `fix:` and `feat:` are allowed, for example [@commitlint/config-conventional](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional) (based on the [the Angular convention](https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#-commit-message-guidelines)) recommends `chore:`, `docs:`, `style:`, `refactor:`, `perf:`, `test:`, and others. +1. _types_ other than `fix:` and `feat:` are allowed, for example [@commitlint/config-conventional](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional) (based on the [the Angular convention](https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#-commit-message-guidelines)) recommends `chore:`, `docs:`, `style:`, `refactor:`, `perf:`, `test:`, and others. +1. _footers_ other than `BREAKING CHANGE: ` may be be provided and and follow a convention similar to + [git trailer format](https://git-scm.com/docs/git-interpret-trailers). -We also recommend `improvement` for commits that improve a current implementation without adding a new feature or fixing a bug. -Notice these types are not mandated by the conventional commits specification, and have no implicit effect in semantic versioning (unless they include a BREAKING CHANGE). -
+Additional types are not mandated by the conventional commits specification, and have no implicit effect in semantic versioning (unless they include a BREAKING CHANGE). +

A scope may be provided to a commit's type, to provide additional contextual information and is contained within parenthesis, e.g., `feat(parser): add ability to parse arrays`. ## Examples -### Commit message with description and breaking change in body +### Commit message with description and breaking change footer ``` feat: allow provided config object to extend other configs @@ -55,11 +56,12 @@ BREAKING CHANGE: `extends` key in config file is now used for extending other co chore!: drop Node 6 from testing matrix ``` -### Commit message with both `!` and BREAKING CHANGE in body +### Commit message with both `!` and BREAKING CHANGE footer ``` chore!: drop Node 6 from testing matrix -BREAKING CHANGE: dropping Node 6 as it hits end of life in April +BREAKING CHANGE: dropping Node 6 as it hits end of +life in April ``` ### Commit message with no body @@ -72,13 +74,16 @@ docs: correct spelling of CHANGELOG feat(lang): add polish language ``` -### Commit message for a fix using an (optional) issue number. +### Commit message with multi-paragraph body and multiple footers ``` fix: correct minor typos in code -see the issue for details on the typos fixed +see the issue for details + +on typos fixed. -closes issue #12 +Reviewed-by: Z +Refs: #133 ``` ## Specification @@ -86,25 +91,32 @@ closes issue #12 The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in [RFC 2119](https://www.ietf.org/rfc/rfc2119.txt). 1. Commits MUST be prefixed with a type, which consists of a noun, `feat`, `fix`, etc., followed - by an OPTIONAL scope, and a REQUIRED terminal colon and space. + by the OPTIONAL scope, OPTIONAL `!`, and REQUIRED terminal colon and space. 1. The type `feat` MUST be used when a commit adds a new feature to your application or library. 1. The type `fix` MUST be used when a commit represents a bug fix for your application. 1. A scope MAY be provided after a type. A scope MUST consist of a noun describing a section of the codebase surrounded by parenthesis, e.g., `fix(parser):` -1. A description MUST immediately follow the space after the type/scope prefix. +1. A description MUST immediately follow the colon and space after the type/scope prefix. The description is a short summary of the code changes, e.g., _fix: array parsing issue when multiple spaces were contained in string._ 1. A longer commit body MAY be provided after the short description, providing additional contextual information about the code changes. The body MUST begin one blank line after the description. -1. A footer of one or more lines MAY be provided one blank line after the body. The footer MUST contain meta-information -about the commit, e.g., related pull-requests, reviewers, breaking changes, with one piece of meta-information -per-line. -1. Breaking changes MUST be indicated in the type/scope prefix of a commit, or at the beginning of its optional body or footer section. -1. If included in the body or footer, a breaking change MUST consist of the uppercase text BREAKING CHANGE, followed by a colon, space, and description, e.g., +1. A commit body is free-form and MAY consist of any number of newline separated paragraphs. +1. One or more footers MAY be provided one blank line after the body. Each footer MUST consist of + a word token, followed by either a `:` or `#` separator, followed by a string value (this is inspired by the + [git trailer convention](https://git-scm.com/docs/git-interpret-trailers)). +1. A footer's token MUST use `-` in place of whitespace characters, e.g., `Acked-by` (this helps differentiate + the footer section from a multi-paragraph body). An exception is made for `BREAKING CHANGE`, which MAY also be used as a token. +1. A footer's value MAY contain spaces and newlines, and parsing MUST terminate when the next valid footer + token/separator pair is observed. +1. Breaking changes MUST be indicated in the type/scope prefix of a commit, or as a trailer + in the footer. +1. If included as a trailer, a breaking change MUST consist of the uppercase text BREAKING CHANGE, followed by a colon, space, and description, e.g., _BREAKING CHANGE: environment variables now take precedence over config files._ 1. If included in the type/scope prefix, breaking changes MUST be indicated by a -`!` immediately before the `:`. If `!` is used, `BREAKING CHANGE:` MAY be ommitted from the -body or footer section, and the commit description SHALL be used to describe the breaking change. -1. Types other than `feat` and `fix` MAY be used in your commit messages. + `!` immediately before the `:`. If `!` is used, `BREAKING CHANGE:` MAY be ommitted from the footer section, + and the commit description SHALL be used to describe the breaking change. +1. Types other than `feat` and `fix` MAY be used in your commit messages, e.g., _docs: updated ref docs._ 1. The units of information that make up conventional commits MUST NOT be treated as case sensitive by implementors, with the exception of BREAKING CHANGE which MUST be uppercase. +1. BREAKING-CHANGE MUST be synonymous with BREAKING CHANGE, when used as a token in a footer. ## Why Use Conventional Commits @@ -161,6 +173,22 @@ In a worst case scenario, it's not the end of the world if a commit lands that d No! If you use a squash based workflow on Git lead maintainers can clean up the commit messages as they're merged—adding no workload to casual committers. A common workflow for this is to have your git system automatically squash commits from a pull request and present a form for the lead maintainer to enter the proper git commit message for the merge. +### How does Conventional Commits handle revert commits? + +Reverting code can be complicated: are you reverting multiple commits? if you revert a feature, should the next release +instead be a patch? + +Conventional Commits does not make an explicit effort to define revert behavior. Instead we leave it to tooling +authors to use the flexility of _types_ and _footers_ to develop their logic for handling reverts. + +One recommendation is to use the `revert` type, and a footer that references the commit SHAs that are being reverted: + +``` +revert: let us never again speak of the noodle incident + +Refs: #676104e, #a215868 +``` + ## About The Conventional Commit specification is inspired by, and based heavily on, the [Angular Commit Guidelines](https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#-commit-message-guidelines). @@ -180,20 +208,22 @@ Configurable and usable for PHP projects as a composer dependency or usable glob * [conform](https://github.com/autonomy/conform): a tool that can be used to enforce policies on git repositories, including conventional commits. * [standard-version](https://github.com/conventional-changelog/standard-version): Automatic versioning and CHANGELOG management, using GitHub's new squash button and the recommended Conventional Commits workflow. * [Git Commit Template](https://plugins.jetbrains.com/plugin/9861-git-commit-template): Add _Conventional Commits_ support to [JetBrains Editors](https://www.jetbrains.com/) (IntelliJ IDEA, PyCharm, PhpStorm...). +* [commitsar](https://github.com/commitsar-app/commitsar): Go tool for checking if commits on branch are conventional commit compliant. Comes with Docker image for CI uses. +* [semantic-release](https://github.com/semantic-release/semantic-release): A tool that automates the whole package release workflow including: determining the next version number, generating the release notes and publishing the package. ## Projects Using Conventional Commits -* [Blaze UI](https://github.com/BlazeUI/blaze): Framework-free open source UI toolkit. -* [electron](https://github.com/electron/electron): Build cross-platform desktop apps with JavaScript, HTML, and CSS. +* [yargs](https://github.com/yargs/yargs): everyone's favorite pirate themed command line argument parser. * [istanbuljs](https://github.com/istanbuljs/istanbuljs): a collection of open-source tools and libraries for adding test coverage to your JavaScript tests. +* [uPortal-home](https://github.com/UW-Madison-DoIT/angularjs-portal) and [uPortal-application-framework](https://github.com/UW-Madison-DoIT/uw-frame): Optional supplemental user interface enhancing [Apereo uPortal](https://www.apereo.org/projects/uportal). * [massive.js](https://github.com/dmfay/massive-js): A data access library for Node and PostgreSQL. -* [mhy](https://mhy.js.org): A zero-config, out-of-the-box, multi-purpose toolbox and development environment. -* [Monica](https://github.com/monicahq/monica): An open source personal relationship management system. +* [electron](https://github.com/electron/electron): Build cross-platform desktop apps with JavaScript, HTML, and CSS. * [scroll-utility](https://github.com/LeDDGroup/scroll-utility): A simple to use scroll utility package for centering elements, and smooth animations -* [uPortal-home](https://github.com/UW-Madison-DoIT/angularjs-portal) and [uPortal-application-framework](https://github.com/UW-Madison-DoIT/uw-frame): Optional supplemental user interface enhancing [Apereo uPortal](https://www.apereo.org/projects/uportal). -* [yargs](https://github.com/yargs/yargs): everyone's favorite pirate themed command line argument parser. -* [yii2-basic-firestarter](https://github.com/HunWalk/yii2-basic-firestarter): 🔥 An enhanced Yii2 app template. +* [Blaze UI](https://github.com/BlazeUI/blaze): Framework-free open source UI toolkit. +* [Monica](https://github.com/monicahq/monica): An open source personal relationship management system. +* [mhy](https://mhy.js.org): 🧩 A zero-config, out-of-the-box, multi-purpose toolbox and development environment. * [@thi.ng/umbrella](https://github.com/thi-ng/umbrella): Monorepo of ~100 TypeScript projects for data driven development +* [yii2-basic-firestarter](https://github.com/HunWalk/yii2-basic-firestarter): 🔥 An enhanced Yii2 app template. [![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org) From 9678e4bc4c557a78927d0dee57f6368042604e13 Mon Sep 17 00:00:00 2001 From: bcoe Date: Fri, 6 Sep 2019 19:32:43 -0700 Subject: [PATCH 3/6] docs: add missing ci --- content/next/index.md | 3 ++- content/v1.0.0/index.md | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/content/next/index.md b/content/next/index.md index 92a8a160..79af480d 100644 --- a/content/next/index.md +++ b/content/next/index.md @@ -33,7 +33,8 @@ consumers of your library: 1. **feat:** a commit of the _type_ `feat` introduces a new feature to the codebase (this correlates with [`MINOR`](http://semver.org/#summary) in semantic versioning). 1. **BREAKING CHANGE:** a commit that has a footer `BREAKING CHANGE:`, or appends a `!` after the type/scope, introduces a breaking API change (correlating with [`MAJOR`](http://semver.org/#summary) in semantic versioning). A BREAKING CHANGE can be part of commits of any _type_. -1. _types_ other than `fix:` and `feat:` are allowed, for example [@commitlint/config-conventional](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional) (based on the [the Angular convention](https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#-commit-message-guidelines)) recommends `chore:`, `docs:`, `style:`, `refactor:`, `perf:`, `test:`, and others. +1. _types_ other than `fix:` and `feat:` are allowed, for example [@commitlint/config-conventional](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional) (based on the [the Angular convention](https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#-commit-message-guidelines)) recommends `chore:`, + `ci', `docs:`, `style:`, `refactor:`, `perf:`, `test:`, and others. 1. _footers_ other than `BREAKING CHANGE: ` may be be provided and and follow a convention similar to [git trailer format](https://git-scm.com/docs/git-interpret-trailers). diff --git a/content/v1.0.0/index.md b/content/v1.0.0/index.md index d7c6a15b..04797c77 100644 --- a/content/v1.0.0/index.md +++ b/content/v1.0.0/index.md @@ -34,7 +34,8 @@ consumers of your library: 1. **feat:** a commit of the _type_ `feat` introduces a new feature to the codebase (this correlates with [`MINOR`](http://semver.org/#summary) in semantic versioning). 1. **BREAKING CHANGE:** a commit that has a footer `BREAKING CHANGE:`, or appends a `!` after the type/scope, introduces a breaking API change (correlating with [`MAJOR`](http://semver.org/#summary) in semantic versioning). A BREAKING CHANGE can be part of commits of any _type_. -1. _types_ other than `fix:` and `feat:` are allowed, for example [@commitlint/config-conventional](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional) (based on the [the Angular convention](https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#-commit-message-guidelines)) recommends `chore:`, `docs:`, `style:`, `refactor:`, `perf:`, `test:`, and others. +1. _types_ other than `fix:` and `feat:` are allowed, for example [@commitlint/config-conventional](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional) (based on the [the Angular convention](https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#-commit-message-guidelines)) recommends `chore:`, + `ci', `docs:`, `style:`, `refactor:`, `perf:`, `test:`, and others. 1. _footers_ other than `BREAKING CHANGE: ` may be be provided and and follow a convention similar to [git trailer format](https://git-scm.com/docs/git-interpret-trailers). From 340c09e36f8c0e07df4548db874f19ab6101e76c Mon Sep 17 00:00:00 2001 From: bcoe Date: Sun, 29 Sep 2019 20:52:44 -0700 Subject: [PATCH 4/6] chore: address review --- content/next/index.md | 23 +++++++++++------------ content/v1.0.0/index.md | 25 ++++++++++++------------- 2 files changed, 23 insertions(+), 25 deletions(-) diff --git a/content/next/index.md b/content/next/index.md index 79af480d..7b722aca 100644 --- a/content/next/index.md +++ b/content/next/index.md @@ -2,7 +2,7 @@ draft: true --- -# Conventional Commits 1.0.1 +# Conventional Commits 1.0.0-next ## Summary @@ -35,7 +35,7 @@ consumers of your library: A BREAKING CHANGE can be part of commits of any _type_. 1. _types_ other than `fix:` and `feat:` are allowed, for example [@commitlint/config-conventional](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional) (based on the [the Angular convention](https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#-commit-message-guidelines)) recommends `chore:`, `ci', `docs:`, `style:`, `refactor:`, `perf:`, `test:`, and others. -1. _footers_ other than `BREAKING CHANGE: ` may be be provided and and follow a convention similar to +1. _footers_ other than `BREAKING CHANGE: ` may be provided and follow a convention similar to [git trailer format](https://git-scm.com/docs/git-interpret-trailers). Additional types are not mandated by the conventional commits specification, and have no implicit effect in semantic versioning (unless they include a BREAKING CHANGE). @@ -53,15 +53,14 @@ BREAKING CHANGE: `extends` key in config file is now used for extending other co ### Commit message with `!` to draw attention to breaking change ``` -chore!: drop Node 6 from testing matrix +refactor!: drop support for Node 6 ``` ### Commit message with both `!` and BREAKING CHANGE footer ``` -chore!: drop Node 6 from testing matrix +refactor!: drop support for Node 6 -BREAKING CHANGE: dropping Node 6 as it hits end of -life in April +BREAKING CHANGE: refactor to use JavaScript features not available in Node 6. ``` ### Commit message with no body @@ -97,7 +96,7 @@ The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL 1. A scope MAY be provided after a type. A scope MUST consist of a noun describing a section of the codebase surrounded by parenthesis, e.g., `fix(parser):` 1. A description MUST immediately follow the colon and space after the type/scope prefix. -The description is a short summary of the code changes, e.g., _fix: array parsing issue when multiple spaces were contained in string._ +The description is a short summary of the code changes, e.g., _fix: array parsing issue when multiple spaces were contained in string_. 1. A longer commit body MAY be provided after the short description, providing additional contextual information about the code changes. The body MUST begin one blank line after the description. 1. A commit body is free-form and MAY consist of any number of newline separated paragraphs. 1. One or more footers MAY be provided one blank line after the body. Each footer MUST consist of @@ -107,10 +106,10 @@ The description is a short summary of the code changes, e.g., _fix: array parsin the footer section from a multi-paragraph body). An exception is made for `BREAKING CHANGE`, which MAY also be used as a token. 1. A footer's value MAY contain spaces and newlines, and parsing MUST terminate when the next valid footer token/separator pair is observed. -1. Breaking changes MUST be indicated in the type/scope prefix of a commit, or as a trailer - in the footer. -1. If included as a trailer, a breaking change MUST consist of the uppercase text BREAKING CHANGE, followed by a colon, space, and description, e.g., -_BREAKING CHANGE: environment variables now take precedence over config files._ +1. Breaking changes MUST be indicated in the type/scope prefix of a commit, or as an entry in the + footer. +1. If included as a footer, a breaking change MUST consist of the uppercase text BREAKING CHANGE, followed by a colon, space, and description, e.g., +_BREAKING CHANGE: environment variables now take precedence over config files_. 1. If included in the type/scope prefix, breaking changes MUST be indicated by a `!` immediately before the `:`. If `!` is used, `BREAKING CHANGE:` MAY be ommitted from the footer section, and the commit description SHALL be used to describe the breaking change. @@ -227,4 +226,4 @@ Configurable and usable for PHP projects as a composer dependency or usable glob [![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org) -_want your project on this list?_ [send a pull request](https://github.com/conventional-changelog/conventionalcommits.org/pulls). \ No newline at end of file +_want your project on this list?_ [send a pull request](https://github.com/conventional-changelog/conventionalcommits.org/pulls). diff --git a/content/v1.0.0/index.md b/content/v1.0.0/index.md index 04797c77..8f5ae146 100644 --- a/content/v1.0.0/index.md +++ b/content/v1.0.0/index.md @@ -34,9 +34,9 @@ consumers of your library: 1. **feat:** a commit of the _type_ `feat` introduces a new feature to the codebase (this correlates with [`MINOR`](http://semver.org/#summary) in semantic versioning). 1. **BREAKING CHANGE:** a commit that has a footer `BREAKING CHANGE:`, or appends a `!` after the type/scope, introduces a breaking API change (correlating with [`MAJOR`](http://semver.org/#summary) in semantic versioning). A BREAKING CHANGE can be part of commits of any _type_. -1. _types_ other than `fix:` and `feat:` are allowed, for example [@commitlint/config-conventional](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional) (based on the [the Angular convention](https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#-commit-message-guidelines)) recommends `chore:`, +1. _types_ other than `fix:` and `feat:` are allowed, for example [@commitlint/config-conventional](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional) (based on the [the Angular convention](https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#-commit-message-guidelines)) recommends `build`, `chore:`, `ci', `docs:`, `style:`, `refactor:`, `perf:`, `test:`, and others. -1. _footers_ other than `BREAKING CHANGE: ` may be be provided and and follow a convention similar to +1. _footers_ other than `BREAKING CHANGE: ` may be provided and follow a convention similar to [git trailer format](https://git-scm.com/docs/git-interpret-trailers). Additional types are not mandated by the conventional commits specification, and have no implicit effect in semantic versioning (unless they include a BREAKING CHANGE). @@ -54,15 +54,14 @@ BREAKING CHANGE: `extends` key in config file is now used for extending other co ### Commit message with `!` to draw attention to breaking change ``` -chore!: drop Node 6 from testing matrix +refactor!: drop support for Node 6 ``` ### Commit message with both `!` and BREAKING CHANGE footer ``` -chore!: drop Node 6 from testing matrix +refactor!: drop support for Node 6 -BREAKING CHANGE: dropping Node 6 as it hits end of -life in April +BREAKING CHANGE: refactor to use JavaScript features not available in Node 6. ``` ### Commit message with no body @@ -84,7 +83,7 @@ see the issue for details on typos fixed. Reviewed-by: Z -Refs: #133 +Refs #133 ``` ## Specification @@ -98,7 +97,7 @@ The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL 1. A scope MAY be provided after a type. A scope MUST consist of a noun describing a section of the codebase surrounded by parenthesis, e.g., `fix(parser):` 1. A description MUST immediately follow the colon and space after the type/scope prefix. -The description is a short summary of the code changes, e.g., _fix: array parsing issue when multiple spaces were contained in string._ +The description is a short summary of the code changes, e.g., _fix: array parsing issue when multiple spaces were contained in string_. 1. A longer commit body MAY be provided after the short description, providing additional contextual information about the code changes. The body MUST begin one blank line after the description. 1. A commit body is free-form and MAY consist of any number of newline separated paragraphs. 1. One or more footers MAY be provided one blank line after the body. Each footer MUST consist of @@ -108,10 +107,10 @@ The description is a short summary of the code changes, e.g., _fix: array parsin the footer section from a multi-paragraph body). An exception is made for `BREAKING CHANGE`, which MAY also be used as a token. 1. A footer's value MAY contain spaces and newlines, and parsing MUST terminate when the next valid footer token/separator pair is observed. -1. Breaking changes MUST be indicated in the type/scope prefix of a commit, or as a trailer - in the footer. -1. If included as a trailer, a breaking change MUST consist of the uppercase text BREAKING CHANGE, followed by a colon, space, and description, e.g., -_BREAKING CHANGE: environment variables now take precedence over config files._ +1. Breaking changes MUST be indicated in the type/scope prefix of a commit, or as an entry in the + footer. +1. If included as a footer, a breaking change MUST consist of the uppercase text BREAKING CHANGE, followed by a colon, space, and description, e.g., +_BREAKING CHANGE: environment variables now take precedence over config files_. 1. If included in the type/scope prefix, breaking changes MUST be indicated by a `!` immediately before the `:`. If `!` is used, `BREAKING CHANGE:` MAY be ommitted from the footer section, and the commit description SHALL be used to describe the breaking change. @@ -187,7 +186,7 @@ One recommendation is to use the `revert` type, and a footer that references the ``` revert: let us never again speak of the noodle incident -Refs: #676104e, #a215868 +Refs: 676104e, a215868 ``` ## About From c0cfcff1b81b876d248fc3147f57db3e067dd896 Mon Sep 17 00:00:00 2001 From: bcoe Date: Sun, 29 Sep 2019 21:00:14 -0700 Subject: [PATCH 5/6] chore: small copy edits --- content/next/index.md | 8 ++++---- content/v1.0.0/index.md | 4 ++-- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/content/next/index.md b/content/next/index.md index 7b722aca..15cd5b4a 100644 --- a/content/next/index.md +++ b/content/next/index.md @@ -33,8 +33,8 @@ consumers of your library: 1. **feat:** a commit of the _type_ `feat` introduces a new feature to the codebase (this correlates with [`MINOR`](http://semver.org/#summary) in semantic versioning). 1. **BREAKING CHANGE:** a commit that has a footer `BREAKING CHANGE:`, or appends a `!` after the type/scope, introduces a breaking API change (correlating with [`MAJOR`](http://semver.org/#summary) in semantic versioning). A BREAKING CHANGE can be part of commits of any _type_. -1. _types_ other than `fix:` and `feat:` are allowed, for example [@commitlint/config-conventional](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional) (based on the [the Angular convention](https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#-commit-message-guidelines)) recommends `chore:`, - `ci', `docs:`, `style:`, `refactor:`, `perf:`, `test:`, and others. +1. _types_ other than `fix:` and `feat:` are allowed, for example [@commitlint/config-conventional](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional) (based on the [the Angular convention](https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#-commit-message-guidelines)) recommends `build:`, `chore:`, + `ci:', `docs:`, `style:`, `refactor:`, `perf:`, `test:`, and others. 1. _footers_ other than `BREAKING CHANGE: ` may be provided and follow a convention similar to [git trailer format](https://git-scm.com/docs/git-interpret-trailers). @@ -82,7 +82,7 @@ see the issue for details on typos fixed. Reviewed-by: Z -Refs: #133 +Refs #133 ``` ## Specification @@ -185,7 +185,7 @@ One recommendation is to use the `revert` type, and a footer that references the ``` revert: let us never again speak of the noodle incident -Refs: #676104e, #a215868 +Refs: 676104e, a215868 ``` ## About diff --git a/content/v1.0.0/index.md b/content/v1.0.0/index.md index 8f5ae146..4e7fc9ce 100644 --- a/content/v1.0.0/index.md +++ b/content/v1.0.0/index.md @@ -34,8 +34,8 @@ consumers of your library: 1. **feat:** a commit of the _type_ `feat` introduces a new feature to the codebase (this correlates with [`MINOR`](http://semver.org/#summary) in semantic versioning). 1. **BREAKING CHANGE:** a commit that has a footer `BREAKING CHANGE:`, or appends a `!` after the type/scope, introduces a breaking API change (correlating with [`MAJOR`](http://semver.org/#summary) in semantic versioning). A BREAKING CHANGE can be part of commits of any _type_. -1. _types_ other than `fix:` and `feat:` are allowed, for example [@commitlint/config-conventional](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional) (based on the [the Angular convention](https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#-commit-message-guidelines)) recommends `build`, `chore:`, - `ci', `docs:`, `style:`, `refactor:`, `perf:`, `test:`, and others. +1. _types_ other than `fix:` and `feat:` are allowed, for example [@commitlint/config-conventional](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional) (based on the [the Angular convention](https://github.com/angular/angular/blob/22b96b9/CONTRIBUTING.md#-commit-message-guidelines)) recommends `build:`, `chore:`, + `ci:', `docs:`, `style:`, `refactor:`, `perf:`, `test:`, and others. 1. _footers_ other than `BREAKING CHANGE: ` may be provided and follow a convention similar to [git trailer format](https://git-scm.com/docs/git-interpret-trailers). From 79d5240325b746cc98a5f1b6e161ccdbf33c2684 Mon Sep 17 00:00:00 2001 From: bcoe Date: Sun, 29 Sep 2019 21:01:16 -0700 Subject: [PATCH 6/6] chore: smally copy tweak --- content/next/index.md | 3 +-- content/v1.0.0/index.md | 3 +-- 2 files changed, 2 insertions(+), 4 deletions(-) diff --git a/content/next/index.md b/content/next/index.md index 15cd5b4a..78d04cee 100644 --- a/content/next/index.md +++ b/content/next/index.md @@ -174,8 +174,7 @@ A common workflow for this is to have your git system automatically squash commi ### How does Conventional Commits handle revert commits? -Reverting code can be complicated: are you reverting multiple commits? if you revert a feature, should the next release -instead be a patch? +Reverting code can be complicated: are you reverting multiple commits? if you revert a feature, should the next release instead be a patch? Conventional Commits does not make an explicit effort to define revert behavior. Instead we leave it to tooling authors to use the flexility of _types_ and _footers_ to develop their logic for handling reverts. diff --git a/content/v1.0.0/index.md b/content/v1.0.0/index.md index 4e7fc9ce..a7b5ae75 100644 --- a/content/v1.0.0/index.md +++ b/content/v1.0.0/index.md @@ -175,8 +175,7 @@ A common workflow for this is to have your git system automatically squash commi ### How does Conventional Commits handle revert commits? -Reverting code can be complicated: are you reverting multiple commits? if you revert a feature, should the next release -instead be a patch? +Reverting code can be complicated: are you reverting multiple commits? if you revert a feature, should the next release instead be a patch? Conventional Commits does not make an explicit effort to define revert behavior. Instead we leave it to tooling authors to use the flexility of _types_ and _footers_ to develop their logic for handling reverts.