Skip to content

Instantly share code, notes, and snippets.

@Ic3fr0g

Ic3fr0g/gitcommit-style.md

Last active January 21, 2019 10:40
Show Gist options
  • Save Ic3fr0g/94624352d411f31f8bfe5def8009f5df to your computer and use it in GitHub Desktop.
Save Ic3fr0g/94624352d411f31f8bfe5def8009f5df to your computer and use it in GitHub Desktop.
Download ZIP
Github commit message - Style guide
Raw
gitcommit-style.md

Github commit message - Style guide

[<COMMIT-TAG>] Imperative one-liner explaining commit (less than 80 chars)
<blank-line>
Description body which could include ordered and unordered lists
1. Lorem ipsum
2. Lorem ipsum
3. Lorem ipsum
<blank-line>
<KEYWORD> #ISSUE

<COMMIT-TAG>

  • ADD: Add a feature
  • MOD: Modifies or reflects a change in logic
  • FIX: Fixes a bug
  • RFC: Refactor internal structure of code without affecting external behaviour
  • STYLE: To deal with those spaces, tabs and line endings
  • DOC: For documentation changes
  • RNM: Renaming a file
  • DEL: Deleting a file

<KEYWORD>

  • Fixes/Fix/Fixed: Fixes an issue
  • Closes/Close/Closed: Closes an issue
  • Resolves/Resolve/Resolved: Resolves an issue
  • Refer: Refers to issue

To close multiple issues use: closes #34, closes #23, and closes example_user/example_repo#42

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