From eaa2fdb50bd0298163fd39b1d153488a74cf4930 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C5=82=20Janiszewski?= Date: Tue, 12 Jul 2016 00:30:34 +0200 Subject: [PATCH] Updated Commit Messages (markdown) --- Commit-Messages.md | 11 ++++++++++- 1 file changed, 10 insertions(+), 1 deletion(-) diff --git a/Commit-Messages.md b/Commit-Messages.md index a1f5743..2c52d97 100644 --- a/Commit-Messages.md +++ b/Commit-Messages.md @@ -27,9 +27,18 @@ Further paragraphs come after blank lines. ``` **Bug Fix:** +Remember that each commit has to be understandable on its own, without having to cross-reference GitHub. + +A commit message like `Fix #1234` is not acceptable. + ``` Fix #3107: Number of sold items is reset after some time Number of sold items was being overwritten by a memmove on the field before it. Queue time changed to only be drawn for rides. -``` \ No newline at end of file +``` + +**Notes** +* If the first line of commit message is too long, GitHub's UI will fold it. It's very likely such commit won't get accepted. +* There has to be one line of space between the topic (first line) and body of commitmsg +* If you cannot fit the description and your commit is large, consider splitting it into smaller chunks. \ No newline at end of file