Skip to content

Instantly share code, notes, and snippets.

@jan-warchol

jan-warchol/writing-good-commit-messages.md

Last active May 15, 2017 07:51
Show Gist options

  • Select an option

    Learn more about clone URLs
  • Save jan-warchol/31aaedb0dda36e05e2d5d2929d73d1b8 to your computer and use it in GitHub Desktop.

Select an option

Learn more about clone URLs
Save jan-warchol/31aaedb0dda36e05e2d5d2929d73d1b8 to your computer and use it in GitHub Desktop.
Download ZIP

Revisions

  1. jan-warchol revised this gist May 15, 2017. 1 changed file with 3 additions and 0 deletions.
    3 changes: 3 additions & 0 deletions writing-good-commit-messages.md
    View file
    Original file line number Diff line number Diff line change
    @@ -2,6 +2,7 @@ Important rules
    - explain why
    - explain why
    - explain why
    - help with code review

    Important formatting rules
    - start with summary line (max 70 characters)
    @@ -13,6 +14,8 @@ Nice-to-have formatting rules
    - add ticket number or other reference
    - use imperative mode
    - mention area affected
    - use hard wraps
    - keep git log in mind

    Inspiration:
    - https://chris.beams.io/posts/git-commit/
  2. jan-warchol created this gist May 15, 2017.
    21 changes: 21 additions & 0 deletions writing-good-commit-messages.md
    View file
    Original file line number Diff line number Diff line change
    @@ -0,0 +1,21 @@
    Important rules
    - explain why
    - explain why
    - explain why

    Important formatting rules
    - start with summary line (max 70 characters)
    - add more description after empty line

    Nice-to-have formatting rules
    - use bullet points
    - capitalize first letter
    - add ticket number or other reference
    - use imperative mode
    - mention area affected

    Inspiration:
    - https://chris.beams.io/posts/git-commit/
    - https://github.com/erlang/otp/wiki/Writing-good-commit-messages
    - https://robots.thoughtbot.com/5-useful-tips-for-a-better-commit-message
    - http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html