[CONTRIBUTING] Update .gitmessage

The template is made more clear and specific.
Added non-mandatory width hints.
This commit is contained in:
Alexander Shaposhnikov 2018-02-25 16:14:41 +02:00 committed by GitHub
parent a0d412b77a
commit 509dd4e645
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -1,20 +1,22 @@
# Commit message example
# ----------------------
# [MODULE] A short but descriptive summary (#pr-num) # [MODULE] A short but descriptive summary (#pr-num)
#
# A comprehensible description of WHY you did this work. # A comprehensible description of WHY you did this work. Do not limit
# yourself here.
# The width of the description is arbitary, but it is a good idea to
# wrap the text by 72 chars.
#
# CORE-XXXX CIDXXXXX # CORE-XXXX CIDXXXXX
# ----------------------
# * [MODULE] should usually be the name of the CMake module, written # * [MODULE] should usually be the name of the CMake module, written
# in all caps. # in all caps.
# # * Summary should be imperative (not past tense) and not end with a
# * Summary should be imperative (not past tense), and not end with # period.
# a period. # * Description of a commit should explain WHY a change was made.
# # * JIRA, Coverity ID references should be placed at the bottom row.
# * Description of commit should explain WHY a change was made. # * There must be a newline between summary, description and bug IDs.
# # * GitHub Pull Request ID should be referenced in the summary in
# * JIRA, Coverity ID references should be placed at the bottom and # parens. If the resulting summary is longer than 70 chars it may
# preceded by the newline. # be placed last in the ID row to prevent hard wrapping on GitHub.
#
# * Pull request should always be referenced in the summary in parens
# unless it doesn't fit. In this case it should be placed after bug
# IDs if any.