From 3e01c62367fe7ed5c24cd6af99207ae393a6c3ee Mon Sep 17 00:00:00 2001 From: Juan Cruz Viotti Date: Thu, 7 Jul 2016 11:35:05 -0400 Subject: [PATCH] docs: commit guidelines (#542) This document will serve as a more expanded guide on the commit conventions we are going to be introducing in this project mainly for the purpose of `CHANGELOG.md` generation. See: https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#commit Signed-off-by: Juan Cruz Viotti --- docs/COMMIT_GUIDELINES.md | 248 ++++++++++++++++++++++++++++++++++++++ 1 file changed, 248 insertions(+) create mode 100644 docs/COMMIT_GUIDELINES.md diff --git a/docs/COMMIT_GUIDELINES.md b/docs/COMMIT_GUIDELINES.md new file mode 100644 index 00000000..614e02b5 --- /dev/null +++ b/docs/COMMIT_GUIDELINES.md @@ -0,0 +1,248 @@ +Commit Guidelines +================= + +We enforce certain rules on commits with the following goals in mind: + +- Be able to reliably auto-generate the `CHANGELOG.md` *without* any human +intervention. +- Be able to automatically and correctly increment the semver version number +based on what was done since the last release. +- Be able to get a quick overview of what happened to the project by glancing +over the commit history. +- Be able to automatically reference relevant changes from a dependency +upgrade. + +The guidelines are inspired by the [AngularJS git commit guidelines][angular-commit-guidelines]. + +Commit structure +---------------- + +Each commit message consists of a header, a body and a footer. The header has a +special format that includes a type, a scope and a subject. + +``` +(): + + + +