From fd1b6444905e258d0b57be85b563fd49cecc7f35 Mon Sep 17 00:00:00 2001 From: Laurent Destailleur Date: Thu, 2 Apr 2015 11:14:32 +0200 Subject: [PATCH] Make things easier to remind. Same rule for commit and PR. --- CONTRIBUTING.md | 25 ++++++++----------------- 1 file changed, 8 insertions(+), 17 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e3a97fe358e..aef8cd57b39 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -42,28 +42,19 @@ Please don't edit the ChangeLog file. A project manager will update it from your Use clear commit messages with the following structure: 
-KEYWORD Short description (may be the bug number #456)
+FIXED|Fixed #456 Short description (where #456 is number of bug fix, if it exists. In upper case to appear into ChangeLog)
+or
+CLOSED|Closed #456 Short description (where #456 is number feature request, if it exists. In upper case to appear into ChangeLog)
+or
+NEW|New Short description (In upper case to appear into ChangeLog)
+or
+Short description (when the commit is not introducing feature or closing a bug)
 
 Long description (Can span accross multiple lines).
-Where KEYWORD is one of: - -- "Fixed" for bug fixes (May be followed by the bug number i.e: #456) -- "Closed" for a commit to close a feature request issue (May be followed by the bug number i.e: #456) -- void, don't put a keyword if the commit is not introducing feature or closing a bug. - ### Pull Requests -When submitting a pull request, use following syntax: - -
-KEYWORD Short description (may be the bug number #456)
-
- -Where KEYWORD is one of: - -- "FIXED" or "Fixed" for bug fixes. In upper case to appear into ChangeLog. (May be followed by the bug number i.e: #456) -- "NEW" or "New" for new features. In upper case to appear into ChangeLog. (May be followed by the task number i.e: #123) +When submitting a pull request, use same rule than Commits. With upper case keyword to appear into ChangeLog. ### Resources