generator-bat
Version:
BAT, the Backbone Application Template; a Yeoman generator collection created by marviq
136 lines (133 loc) • 5.21 kB
Plain Text
# ============================================================================
# Commit Message Format for automated CHANGELOG generation.
# ----------------------------------------------------------------------------
#
# <type>([<scope>]): <subject>
# [ <BLANK LINE> <body> ]
# [ <BLANK LINE> <footer> ]
#
# type :: What type of change this commit contains;
# scope :: What item of code this commit is changing;
# subject :: A short description of the change;
#
# body :: A more in-depth description of the change;
#
# footer :: References to issues that this change closes, as well as
# Information about `BREAKING CHANGE`s.
#
# <type>
# ----------------------------------------------------------------------------
#
# Is recommended to be one of the below items. If the prefix is `feat`,
# `fix` or `perf`, it will appear in the CHANGELOG. However, if there is
# any `BREAKING CHANGE`, the commit will always appear in the CHANGELOG.
#
# * feat: A new feature;
# * fix: A bug fix;
# * docs: Documentation only changes;
# * style: Changes that do not affect the meaning of the code
# (white-space, formatting, missing semi-colons, etc);
# * refactor: A code change that neither fixes a bug nor adds a
# feature;
# * perf: A code change that improves performance;
# * test: Adding missing tests;
# * chore: Changes to the build process or auxiliary tools and
# libraries such as documentation generation;
#
# <scope>
# ----------------------------------------------------------------------------
#
# Could be anything specifying place of the commit change. For example
# `$location`, `$browser`, `$compile`, `$rootScope`, `ngHref`, `ngClick`,
# `ngView`, etc...
#
# <subject>
# ----------------------------------------------------------------------------
#
# A succinct description of the change:
#
# * Use the imperative, present tense: "change" not "changed" nor
# "changes";
# * Don't capitalize first letter;
# * No dot (.) at the end;
#
# <body>
# ----------------------------------------------------------------------------
#
# Just as in the <subject>, use the imperative, present tense: "change"
# not "changed" nor "changes".
#
# The body should include the motivation for the change and contrast this
# with previous behavior.
#
# <footer>
# ----------------------------------------------------------------------------
#
# 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.
#
# 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 <hash>.`, where the <hash>
# is the SHA of the commit being reverted.
#
#
# ============================================================================
# Examples
# ----------------------------------------------------------------------------
#
# Appears under "Features" header, pencil subheader:
#
# feat(pencil): add 'graphiteWidth' option
#
#
# Appears under "Bug Fixes" header, graphite subheader, with a link to
# issue #28:
#
# fix(graphite): stop graphite breaking when width < 0.1
#
# Closes #28
#
#
# Appears under "Performance Improvements" header, and under
# "Breaking Changes" with the breaking change explanation:
#
# perf(pencil): remove graphiteWidth option
#
# BREAKING CHANGE:
#
# The graphiteWidth option has been removed. The default graphite width
# of 10mm is always used for performance reason.
#
#
# The following commit and commit `667ecc1` do not appear in the CHANGELOG if
# they are under the same release. If not, the revert commit appears under
# the "Reverts" header.
#
# revert: feat(pencil): add 'graphiteWidth' option
#
# This reverts commit 667ecc1654a317a13331b17617d973392f415f02.
#
#
# ============================================================================
# Original Specification:
# ----------------------------------------------------------------------------
#
# * Adapted from:
#
# https://github.com/bcoe/conventional-changelog-standard/blob/v1.2.1/convention.md#commit-message-format
# https://github.com/angular/angular.js/blob/v1.5.7/CONTRIBUTING.md#commit
#
# * Latest:
#
# https://github.com/bcoe/conventional-changelog-standard/blob/master/convention.md#commit-message-format
# https://github.com/angular/angular.js/blob/master/CONTRIBUTING.md#commit
#