From f9fc524a74ebb7f5f6c538aef8e1d725f48a9499 Mon Sep 17 00:00:00 2001 From: Dmitriy Shekhovtsov Date: Fri, 20 May 2016 01:19:01 +0300 Subject: [PATCH] chore(contributing): added commit message samples (#7375) Each time I am pointing someone to this contribution doc to read and apply commit message style guide each time type part of message formatting is missed --- CONTRIBUTING.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e65331a627..0bd75c0407 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -166,6 +166,19 @@ The **header** is mandatory and the **scope** of the header is optional. 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. +Footer should contain a [closing reference to an issue](https://help.github.com/articles/closing-issues-via-commit-messages/) if any. + +Samples: (even more [samples](https://github.com/angular/angular/commits/master)) + +``` +docs(changelog): update change log to beta.5 +``` +``` +fix(release): need to depend on latest rxjs and zone.js + +The version in our package.json gets copied to the one we publish, and users need the latest of these. +``` + ### 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.