Why?
Because Gitmoji is bloated and, in practice, I personally use at max 10 of its emojis for any of my hybrid apps or sites. A limited set of emojis removes the guessing process of picking or reading emojis. It also helps to automatically generate a readable changelog, or create data-driven actions on specific commits.
Comigojis are also short and easy to remember. No more unmemorable :globe_with_meridians: or :speech_balloon:!
There are just nine emojis divided to three groups:
- Three of them to describe the development;
- Three another to comment on non-functional stuff;
- And the last three to highlight the most notable events of your development, be it good ones or not.
And yes, I named them after myself. Booo!
Naming convention
If not otherwise noted in your repo, use the following structure:
${emoji} ${scope}: ${message}, or simply
${emoji} ${message}.
Use imperative mood for your messages and, please, don't write "Fix an issue with…" or "Commit …" or "Upload assets for …". You are already uploading a commit with a fix for an issue! Good examples:
- :wrench: Textures: Optimize the loading process of image import
- :bug: Rooms: Fix displaced textures in nested rooms
- :books: Debugger: Document helper functions that are available in development builds and debug mode
- :briefcase: Tutorials: Provide additional textures for "Making a space shooter"
and so on.
Flavors
- "Vanilla" is what I see as a good emoji guide.
- "Gitmoji-like" is the flavor that I use in repos that started with Gitmoji, and, generally speaking, is a compatible subset of it.
You can copy these links to share a specific flavor with your colleagues.
Tools
- comigoji-changelog for generating a neat-looking changelog from a number of repositories at once.
Created a new one? Post a pull request so it can be added here!