Skip to content
This repository has been archived by the owner on Jan 10, 2023. It is now read-only.

Commit

Permalink
Tighten up the language in the Git commit template
Browse files Browse the repository at this point in the history
Based on Sarah Kerns' advice:
- Consider removing the 'why' behind statements.
- Focus on being a glance-able reminder of the conventions.

The changes - so far - have made the template 4 lines shorter and much
more 'glance-able'.
  • Loading branch information
jamesiain authored and James MacMillan committed Jan 10, 2023
1 parent e4b4c45 commit 729cc89
Showing 1 changed file with 8 additions and 11 deletions.
19 changes: 8 additions & 11 deletions gitmessage
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,14 @@

# Summarize the commit with 50-characters, or less
#
# Note: This first blank line separating the body from the subject line
# is critical.
#
# The subject line is treated as a title in several tools so consistency
# matters for readability. Always capitalize the first character and do
# not end with a period.
#
# After that first blank line - optionally - provide a 72-character
# wrapped detailed description. Each commit should address only one
# feature or defect. Consider breaking unfocused commits up into smaller
# targeted ones. Separate paragraphs with blank lines as required.
# Note: This first blank line delimits the subject line as required by
# several tools. Always capitalize the subject's first character
# and do not end with a period.
#
# Next, provide a 72-character wrapped detailed description. Each commit
# should address only one feature or defect. Consider breaking unfocused
# commits up into smaller targeted ones. Separate paragraphs with blank
# lines as required.
#
# Important questions to answer:
# - Why is this change necessary?
Expand Down

0 comments on commit 729cc89

Please sign in to comment.