From 1509bc8897deac6ec3223e2f5ec67ba59cdf64b9 Mon Sep 17 00:00:00 2001 From: Steve Mao Date: Wed, 1 Jul 2015 10:11:49 +1000 Subject: [PATCH 1/3] docs(CONTRIBUTING): revert is a modifier EG: https://github.com/angular/angular.js/commit/462f444b06ae5cad3ccb761b1dba7131df01a655 --- CONTRIBUTING.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8c130104a3e0..5693b7015da0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -202,6 +202,9 @@ format that includes a **type**, a **scope** and a **subject**: Any line of the commit message cannot be longer 100 characters! This allows the message to be easier to read on github as well as in various git tools. +### Revert +If the commit reverts a previous commit, it should begin with `revert: `, followed by the header of the reverted commit. In the body it should say: `This reverts commit .`, where the hash is the SHA of the commit being reverted. + ### Type Must be one of the following: From 5b49dbb220a374a6b06ee9daf8aa1dfaac230f6b Mon Sep 17 00:00:00 2001 From: Steve Mao Date: Wed, 1 Jul 2015 10:05:23 +1000 Subject: [PATCH 2/3] docs(CONTRIBUTING): how to write a breaking change --- CONTRIBUTING.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5693b7015da0..873cc39a9070 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -238,6 +238,7 @@ The body should include the motivation for the change and contrast this with pre The footer should contain any information about **Breaking Changes** and is also the place to reference GitHub issues that this commit **Closes**. +**Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines. The rest of the commit message is then used for this. A detailed explanation can be found in this [document][commit-message-format]. From 22ba88638146252b1e07d7c23128488d482c3072 Mon Sep 17 00:00:00 2001 From: Steve Mao Date: Wed, 1 Jul 2015 10:08:03 +1000 Subject: [PATCH 3/3] docs(CONTRIBUTING): state what is mandatory or optional --- CONTRIBUTING.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 873cc39a9070..362f3fd2e126 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -199,6 +199,8 @@ format that includes a **type**, a **scope** and a **subject**: