Skip to content

Instantly share code, notes, and snippets.

@runningdemo
Created September 28, 2014 07:02
Show Gist options
  • Save runningdemo/7fc9ae8c6ca9087b402e to your computer and use it in GitHub Desktop.
Save runningdemo/7fc9ae8c6ca9087b402e to your computer and use it in GitHub Desktop.

1. Write the summary line and description of what you have done in the imperative mode, that is as if you were commanding someone. Write "fix", "add", "change" instead of "fixed", "added", "changed".

  • fix

  • remove

  • update

  • refactor

  • add

          * bafaeac TJ Holowaychuk — add mixin property array support
          * e9df63a TJ Holowaychuk — remove opacity plugin. Closes #29
          * c5b1e85 TJ Holowaychuk — remove media macros. Closes #36
    

2. Always leave the second line blank.

3.Line break the commit message (to make the commit message readable without having to scroll horizontally in gitk).

4. Branch Names

Nothing too special here, I typically just use the same convention as commit messages for branches like “add/my-feature”, “remove/old-feature”, “fix/crazy-bug”.

Don't

1. Don't end the summary line with a period.

Links

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