1 2# Commit message example 3# ---------------------- 4# [MODULE] A short but descriptive summary (#pr-num) 5# 6# A comprehensible description of WHY you did this work. Do not limit 7# yourself here. 8# The width of the description is arbitary, but it is a good idea to 9# wrap the text by 72 chars. 10# 11# CORE-XXXX CIDXXXXX 12# ---------------------- 13# * [MODULE] should usually be the name of the CMake module, written 14# in all caps. 15# * Summary should be imperative (not past tense) and not end with a 16# period. 17# * Description of a commit should explain WHY a change was made. 18# * JIRA, Coverity ID references should be placed at the bottom row. 19# * There must be a newline between summary, description and bug IDs. 20# * GitHub Pull Request ID should be referenced in the summary in 21# parens. If the resulting summary is longer than 70 chars it may 22# be placed last in the ID row to prevent hard wrapping on GitHub. 23