├── Gemfile ├── LICENSE ├── .gitignore ├── _config.yml ├── CONTRIBUTING.md ├── _includes └── head-custom-google-analytics.html └── README.md /Gemfile: -------------------------------------------------------------------------------- 1 | source 'https://rubygems.org' 2 | gem 'github-pages', group: :jekyll_plugins 3 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | The Code is licensed under the [MIT License](http://slashsbin.mit-license.org/). 4 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | ### Ruby ### 2 | Gemfile.lock 3 | 4 | ### Jekyll ### 5 | _site/ 6 | .sass-cache/ 7 | .jekyll-metadata 8 | -------------------------------------------------------------------------------- /_config.yml: -------------------------------------------------------------------------------- 1 | theme: jekyll-theme-hacker 2 | show_downloads: false 3 | google_analytics: G-N6DVDQE97E 4 | gems: 5 | - jemoji 6 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing 2 | 3 | [Ask](https://github.com/slashsBin/styleguide-git-commit-message/issues/new) to Be [Creative](https://www.emojicopy.com/)! 4 | 5 | To add a new Emoji to the list: [Create an Issue](https://github.com/slashsBin/styleguide-git-commit-message/issues/new) & Send a [PR](). 6 | -------------------------------------------------------------------------------- /_includes/head-custom-google-analytics.html: -------------------------------------------------------------------------------- 1 | {% if site.google_analytics %} 2 | 3 | 10 | {% endif %} 11 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 |

2 | Git 3 | & 4 | Unicorn 5 |

6 | 7 |

8 | Powered by Emojis! 9 | GitHub contributors 10 | GitHub stars 11 | license 12 |

13 | 14 | # Git Commit Message StyleGuide 15 | 16 | ##### TOC 17 | - [About](#about) 18 | - [Commit Message Format](#commit-message-format) 19 | - [Suggested Emojis](#suggested-emojis) 20 | - [Tools](#tools) 21 | - [Related Ideas](#related-ideas) 22 | - [Fun Emoji Usages](#fun-emoji-usages) 23 | - [Contributing](#contributing) 24 | - [License](#license) 25 | 26 | 27 | ## About 28 | This is an attempt to standardize the format of commit messages, for the sake of **uniformity** in git log, **best practices** for writing commit messages & **fun**! 29 | 30 | Using emojis at the beginning of commit messages, other than being fun, provides a simple way to indicate the intention of that commit, an ease for the eyes when browsing/reviewing git log. It's also a simple measure of the fact that how much that commit is focused on a single purpose, which is a good practice. 31 | 32 | If these rules and/or using emojis is an [overkill](/../../issues/21) for your productivity or simply losing its purposes, please tailor them to your needs or don't use them. 33 | 34 | ### Summary of the reasons for these conventions: 35 | - Fun! 36 | - Simple navigation through git history (e.g. ignoring style changes). 37 | - Automatic generating of the changelog. 38 | 39 | 40 | ## Commit Message Format 41 | 42 | ``` 43 | (): 44 | 45 | 46 | 47 |