From 2c7b4fb44943b2ab83b36c4be1fc36f6ba2258f2 Mon Sep 17 00:00:00 2001 From: Pyfisch Date: Mon, 26 Jan 2015 11:01:31 +0100 Subject: [PATCH] chore(git): clarify CONTRIBUTING.md It turned out in #271 that the current description for commit messages introducing breaking changes is not clear enough. --- CONTRIBUTING.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 773a0958..c3e23bf0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -67,6 +67,8 @@ 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**. +The last line of commits introducing breaking changes should be in the form `BREAKING_CHANGE: ` + A detailed explanation can be found in this [document][commit-message-format].