[CONTRIBUTING] Add a commit template and a paragraph about it

This template defines a general commit style, and will be most
helpful for newcomers. I will be using it personally :)
This commit is contained in:
Alexander Shaposhnikov
2018-01-28 00:51:48 +02:00
parent c54c5ebb5f
commit d70741fa20
2 changed files with 28 additions and 0 deletions

23
.gitmessage Normal file
View File

@@ -0,0 +1,23 @@
# [MODULE] A short but descriptive summary (#pr-num)
# A comprehensible description of WHY you did this work.
# CORE-XXXX CIDXXXXX
#--------------------------------------------------------------------^
# 70^
# * [MODULE] should usually be the name of the CMake module, written
# in all caps.
#
# * Summary should be imperative (not past tense), 70 characters or
# less, and not end with a period.
#
# * Description of commit should explain WHY a change was made and
# lines should be also wrapped to 70 characters.
#
# * JIRA, Coverity ID references should be placed at the bottom and
# preceded by the newline.
#
# * 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.