Skip to content

Instantly share code, notes, and snippets.

@amaankulshreshtha
Last active July 8, 2019 17:59
Show Gist options
  • Star 1 You must be signed in to star a gist
  • Fork 1 You must be signed in to fork a gist
  • Save amaankulshreshtha/0e3cf7c888f71808779cedb56c0a6d25 to your computer and use it in GitHub Desktop.
Save amaankulshreshtha/0e3cf7c888f71808779cedb56c0a6d25 to your computer and use it in GitHub Desktop.
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