Skip to content

Instantly share code, notes, and snippets.

@mguilhermetavares
Last active March 31, 2023 14:13
Show Gist options
  • Star 5 You must be signed in to star a gist
  • Fork 2 You must be signed in to fork a gist
  • Save mguilhermetavares/4256fe4864b5c48282d1f9b6cbaf0dde to your computer and use it in GitHub Desktop.
Save mguilhermetavares/4256fe4864b5c48282d1f9b6cbaf0dde to your computer and use it in GitHub Desktop.
Commit Style Guides

Custom commit messages

  • All commits must be "SignOff", just use "commit -sm"
  • Use imperative verbs ("Add feature" instead of "Adding feature" or "Added feature")
  • First line must have a maximum of 72 characters
  • Consider describing it in detail in the commit body
  • Consider using an emoji at the beginning of the commit message
Emoji Code Commit Type
✨ :sparkles: New feature
πŸŽ‰ :tada: Initial commit
πŸ’… :nail_care: Improve UI/UX
🎨 :art: Improve the structure/code format
🐎 :racehorse: Improve performance
πŸ“ :memo: Write documentation
πŸ› :bug: Fix bugs
πŸ”₯ :fire: Fix bugs in production (hotfix)
πŸ’š :green_heart: Fix a CI build
βœ… :white_check_mark: Add tests
πŸ”’ :lock: Improve security
⬆️ :arrow_up: Update dependencies
⬇️ :arrow_down: Downgrade dependencies
πŸ’© :poop: Deprecated
🚧 :construction: Under construction
πŸš€ :rocket: New version
πŸ™ˆ :see_no_evil: Work around (pt-br: "Gambiarra")
🐳 :whale: Docker
πŸ‘Œ :ok_hand: Code review changes
πŸ”¨ :hammer: Refactor code
πŸ’₯ :boom: Conflict merge
βœ‚οΈ :scissors: Legacy code removal
🌌 :milky_way: Add iamges/icons
Other Be creative

Example

git commit -sm ":memo: Add contribution instructions"
-m "The CONTRIBUTING.md file was created with instructions on how to make a good commit"

If you are using JIRA

git commit -sm ":memo: Add contribution instructions"
-m "The CONTRIBUTING.md file was created with instructions on how to make a good commit"
-m "JIRA-123"
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment