Commoji

• Features
• Usage
  • Format
  • Tags
  • Scope
  • Verbs
  • Object
• Examples
• Changelog
• License
• Support
• Related
• Author

Commoji’s purpose is to transform the way developers communicate intent through commit messages – by blending semantic clarity with visual expressiveness. It's not just a tagging system; it’s a visual grammar for storytelling in code.

Commoji proposes the following formats when writing commit messages:

• when the scope is known or not global: <emoji> <tag>(<scope>): <verb> <object>

• when the scope is unknown or global: <emoji> <tag>: <verb> <object>

Use the UTF-8 emoji glyph wherever possible.
If your environment doesn’t render emojis, fall back to the ASCII aliases below.

All the elements except the scope and the object should be taken from the tables below. While the object is free-form, it should ideally be a concise, semantically clear noun phrase. See additional recommendations for the object below.

Commoji achieves its goal by defining the following tags, their purpose, emoji and the fallback/alias ASCII sequence:

The scope of a commit narrows its focus to a specific section of your codebase, such as a module, feature, or directory. This enables readers to swiftly determine where the change is applicable without the necessity of reviewing the entire diff.

When selecting a scope, please follow these guidelines:

• choose the name of the pertinent module, component, or feature folder (for example, auth, ui, api, database),
• write scopes in lowercase and use hyphens for names that consist of multiple words (for instance, user-profile, error-handler)
• avoid using excessively broad or generic scopes (like core, misc), as they detract from the purpose of scoping.
• if the change impacts the project as a whole or spans multiple areas, it is recommended to omit the scope altogether.

Commoji also proposes the following imperative verbs to be used when writing commit messages:

The object in the commit message should be specific enough to convey what changed. Aim for a concise noun phrase that captures intent; use the commit body for details.

Guidelines:

• use a precise noun phrase whenever applicable

✅ Good: 📚 docs: add ToC to README

❌ Bad: 📚 docs: update README (too generic)

• don’t list every change in the summary
• summarize the primary intent, e.g., “add OAuth section,” not “add OAuth section, fix typo, update link.”
• leverage the commit body for elaboration:

📚 docs: add ToC to README

- generated Table of Contents for each heading  
- updated README links to anchor tags  
- fixed minor typos in examples

When a change truly spans multiple concerns, choose a higher-level verb:

📚 docs: overhaul README, then explain sub-items in the body.

🔬 Examples

Here are some examples of objects when writing commit messages that adhere to Commoji's conventions.

The following table shows some usage examples that are valid or invalid according to Commoji’s formatting guidelines.

📑 See the full changelog in: CHANGELOG.md.

Licensed under the MIT license which is available here, MIT license.

I work hard for every project, including this one and your support means a lot to me!
Consider buying me a coffee. ☕



Thank you for supporting my efforts! 🙏😊

@igor.dvlpr/scrollend-polyfill

🛴 A performant and light (< 1.5KB) JavaScript polyfill for the scrollend Event. ⛸️

@igor.dvlpr/zing

🐌 Zing is a C# style String formatter for JavaScript that empowers Strings with positional arguments - composite formatting. 🚀

@igor.dvlpr/strip-yaml-front-matter

🦓 Strips YAML front matter from a String or a file. 👾

@igor.dvlpr/registry-apppaths

🪀 A Node.js module for reading the AppPaths registry key on Windows. Useful for retrieving applications that can be launched from the command prompt. 🗃

@igor.dvlpr/emojilyzer

💬 Emojifies strings, converting textual representations of emojis to graphical ones. 🖌️

Created by Igor Dimitrijević (@igorskyflyer).