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