Skip to content

Instantly share code, notes, and snippets.

@thebiltheory

thebiltheory/commitMessageConventions.md

Forked from amaankulshreshtha/Commit message Conventions
Created June 17, 2019 06:28
Show Gist options
  • Save thebiltheory/12976bc4f0327f13fde9d3351c08842f to your computer and use it in GitHub Desktop.
Save thebiltheory/12976bc4f0327f13fde9d3351c08842f to your computer and use it in GitHub Desktop.
Download ZIP
Commit message Conventions
Raw
commitMessageConventions.md

FORMAT:

<type>[optional scope]: <description>

[optional body]

[optional footer]

TYPES:

  • 👀✨feat: A new feature
  • 🐞✅fix: A bug fix
  • 🤓📖docs: Documentation only changes
  • 🧷😌style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
  • 😍🍬refactor: A code change that neither fixes a bug nor adds a feature
  • 🏎💨perf: A code change that improves performance
  • 🧪📊test: Adding missing or correcting existing tests
  • 🛠📦chore: Changes to the build process or auxiliary tools and libraries such as documentation generation

EXAMPLES:

Commit message with description and breaking change in body

feat: allow provided config object to extend other configs

BREAKING CHANGE: `extends` key in config file is now used for extending other config files

Commit message with no body

docs: correct spelling of CHANGELOG

Commit message with scope

feat(lang): added polish language
Commit message for a fix using an (optional) issue number.
fix: minor typos in code

see the issue for details on the typos fixed

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