forked from tungstenfabric/tf-controller
-
Notifications
You must be signed in to change notification settings - Fork 1
/
git_commit_template.txt
67 lines (55 loc) · 1.74 KB
/
git_commit_template.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
# Git Template
# Guidelines Version: 1.0
# General
# - Use one blank line after each section
# Title
# - Mandatory
# - One line, Maximum 50 characters
# - Imperative
# Jira Tags
# - Mandatory
# - Respective Jira ID must be referenced
# - Do not refer a closed ticket
# Gerrit Dependencies
# - Optional
# - One Change-ID per line
# Author
# - Mandatory
# - Include '-s' during git commit which should add
# Signed-Off-by: <Name> <email-ID>
# Co-Author
# - format:
# Co-Authored-by: <Name> <email-ID>
# - One Co-Author per line
# Summary
# - Mandatory
# - Maximum 72 characters per line
# - Use hyphen or numbers as bullets
# - Add explanation about the problem
# - Focus on why this patch is required
# - Add side-effects or consequences if any
# - Do not assume reviewer understands the
# original problem or the patch
# References
# - Optional
# - Provide links for further reading or
# references if any
#
# How to use this template
# - Copy this file to ~/.git_template
# - Execute
# git config --global commit.template ~/.git_template
# - Do not work with commit amend
# -------------------- Title ------------------ #
# ------------------ Jira Tags ---------------- #
# closes-jira-bug:
# partial-jira-bug:
# ------------ Gerrit Dependencies ------------ #
# Depends-On:
# ------------------ Authors ------------------ #
# Author:
# Co-Author:
# ------------ Summary about why the patch is required -------------- #
# -------------------- Summary about the patch ---------------------- #
# --------------------------- References ---------------------------- #
# -------------------------- End of message ------------------------- #