diff options
Diffstat (limited to '.gitmessage')
| -rw-r--r-- | .gitmessage | 32 |
1 files changed, 25 insertions, 7 deletions
diff --git a/.gitmessage b/.gitmessage index a24d109..1eb44e6 100644 --- a/.gitmessage +++ b/.gitmessage @@ -1,8 +1,26 @@ -# <type>: <subject> (max 50 chars) -# |<---- Using a Maximum Of 50 Characters ---->| - -# Explain why this change is being made -# |<---- Try To Limit Each Line to a Maximum Of 72 Characters ---->| - -# Provide links to any relevant tickets, articles or other resources +# Summarize change in 50 characters or less +# +# More detailed explanatory text, if necessary. Wrap it to about 72 +# characters or so. In some contexts, the first line is treated as the +# subject of the email and the rest of the text as the body. The +# blank line separating the summary from the body is critical (unless +# you omit the body entirely); various tools like `log`, `shortlog` +# and `rebase` can get confused if you run the two together. +# +# Explain the problem that this commit solves. Focus on why you are +# making this change as opposed to how (the code explains that). +# Are there side effects or other unintuitive consequences of this +# change? Here's the place to explain them. +# +# Further paragraphs come after blank lines. +# +# - Bullet points are okay, too +# +# - Typically a hyphen or asterisk is used for the bullet, preceded +# by a single space, with blank lines in between, but conventions +# vary here +# +# If applied, this commit will... +# Why was this change made? +# Any references to tickets, articles, etc? |