2018-01-28 06:51:48 +08:00
|
|
|
|
2018-02-25 22:14:41 +08:00
|
|
|
# Commit message example
|
|
|
|
|
# ----------------------
|
|
|
|
|
# [MODULE] A short but descriptive summary (#pr-num)
|
|
|
|
|
#
|
|
|
|
|
# A comprehensible description of WHY you did this work. Do not limit
|
2021-09-13 09:33:14 +08:00
|
|
|
# yourself here.
|
|
|
|
|
# The width of the description is arbitary, but it is a good idea to
|
|
|
|
|
# wrap the text by 72 chars.
|
2018-02-25 22:14:41 +08:00
|
|
|
#
|
2018-01-28 06:51:48 +08:00
|
|
|
# CORE-XXXX CIDXXXXX
|
2018-02-25 22:14:41 +08:00
|
|
|
# ----------------------
|
2018-01-28 06:51:48 +08:00
|
|
|
# * [MODULE] should usually be the name of the CMake module, written
|
|
|
|
|
# in all caps.
|
2018-02-25 22:14:41 +08:00
|
|
|
# * Summary should be imperative (not past tense) and not end with a
|
|
|
|
|
# period.
|
|
|
|
|
# * Description of a commit should explain WHY a change was made.
|
|
|
|
|
# * JIRA, Coverity ID references should be placed at the bottom row.
|
|
|
|
|
# * There must be a newline between summary, description and bug IDs.
|
2021-09-13 09:33:14 +08:00
|
|
|
# * GitHub Pull Request ID should be referenced in the summary in
|
|
|
|
|
# parens. If the resulting summary is longer than 70 chars it may
|
2018-02-25 22:14:41 +08:00
|
|
|
# be placed last in the ID row to prevent hard wrapping on GitHub.
|
