Skip to content

Instantly share code, notes, and snippets.

@samchrisinger
Last active July 10, 2017 22:42
Show Gist options
  • Star 3 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save samchrisinger/1d0dfa5cf52be2d56772 to your computer and use it in GitHub Desktop.
Save samchrisinger/1d0dfa5cf52be2d56772 to your computer and use it in GitHub Desktop.
Git commit message template
# Is this WIP or a minor change?
# [skip ci]
# Are you ready to indicate a related Jira issue?
# [#OSF- ]
# Style guidelines
# ----------------
# Capitalized, short (50 chars or less) summary
#
# 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 an 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); tools like rebase can get confused if you run the
# two together.
#
# Write your commit message in the imperative: "Fix bug" and not "Fixed bug"
# or "Fixes bug." This convention matches up with commit messages generated
# by commands like git merge and git revert.
#
# Further paragraphs come after blank lines.
#
# - Bullet points are okay, too
#
# - Typically a hyphen or asterisk is used for the bullet, followed by a
# single space, with blank lines in between, but conventions vary here
#
# - Use a hanging indent
@samchrisinger
Copy link
Author

Configure git to preload this into your commit messages to help remind you of style guidelines and to skip ci when appropriate.

  1. cd to osf.io
  2. save this gist in .git/commit_message_template
  3. run git config --local commit.template "./.git/commit_message_template"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment