@namastexlabs/speak
Version:
Open source voice dictation for everyone
304 lines (233 loc) โข 8.03 kB
Markdown
# ๐จ Emoji Naming Convention
**Version:** 1.0.0
**Status:** ACTIVE
**Approved By:** Felipe (2025-10-21)
## ๐ฏ Mission
**Universal visual language across all systems:**
- GitHub issues = same emoji as Forge tasks = same emoji as Agent sessions
- Instant recognition without reading title
- Same language everywhere: Genie โ Forge โ GitHub
## ๐ Standard Format
```
[<emoji>] <Type>: <Title> (#GitHubIssue)
```
**Brackets provide:**
- Structure for extraction/parsing
- Visual framing that makes emojis pop
- Clear boundaries between emoji and text
**Examples:**
```
[๐] Bug: Forge executor hardcodes base_branch (#154)
[๐ญ] Wish: MCP Server Authentication (#152)
[๐] Learn: Task Naming Convention Standardization (#157)
[โ๏ธ] Forge: Drop-in replacement executor (#143)
[๐ค] implementor: background
```
## ๐จ Work Type Emojis
### Core Work Types
| Emoji | Type | When To Use |
|-------|------|-------------|
| ๐ | Bug | Something broken, needs fixing |
| ๐ญ | Wish | Discovery/planning for new features |
| ๐ | Learn | Research, investigation, knowledge capture |
| โ๏ธ | Forge | Implementation of approved work |
| โ
| Review | Quality assurance, validation |
| ๐จ | Refactor | Code improvement without new features |
| ๐ | Docs | Writing/updating documentation |
| ๐งน | Chore | Maintenance, dependencies, housekeeping |
## ๐ง Agent Emojis
### Core Orchestrators
| Emoji | Agent | Usage |
|-------|-------|-------|
| ๐ง | Genie | Main orchestrator |
| ๐ญ | Wish | Wish dance orchestrator |
| โ๏ธ | Forge | Task breakdown |
| โ
| Review | Quality validation |
### Specialist Agents
| Emoji | Agent | Usage |
|-------|-------|-------|
| ๐ค | Implementor | Code implementation (robot) |
| ๐ค | Tests | Test writing (robot) |
| ๐ค | Polish | Code polishing (robot) |
| ๐ค | Refactor | Code refactoring (robot) |
| ๐ | Release | Release management |
| โ๏ธ | Prompt | Instruction writing |
| ๐ง | Git | GitHub operations |
| ๐ | Commit | Commit crafting |
| ๐ | Debug | Debugging |
| ๐๏ธ | Install | Installation |
**Note:** ๐ค Robot emoji for all execution agents (they do the work)
### Thinking Modes
| Emoji | Agent | Usage |
|-------|-------|-------|
| ๐ง | Analyze | Deep analysis |
| ๐ฏ | Plan | Strategic planning |
| ๐ค | Socratic | Questioning/learning |
| ๐ฌ | Deep-Dive | Detailed investigation |
| ๐ | Explore | Codebase exploration |
## ๐ฏ Usage Guidelines
### When Creating Forge Tasks
**Format:**
```typescript
await mcp__automagik_forge__create_task({
project_id: projectId,
title: "[๐] Bug: Clear description of the bug (#GitHubIssueNumber)",
description: "Full context here..."
});
```
**Rules:**
1. **Choose ONE emoji** from work type table
2. **Wrap in brackets:** `[๐]` not `๐`
3. **Match work type:** Bug=๐, Wish=๐ญ, Learn=๐, Forge=โ๏ธ, etc.
4. **Include GitHub issue:** `(#NNN)` at end of title
5. **Keep title โค 80 characters** including emoji and brackets
### When Creating GitHub Issues
**Format:**
```bash
gh issue create \
--title "[๐] Bug: Clear description of the bug" \
--body "Full description..." \
--label "type:bug,area:forge"
```
**After creation, update Forge task to include issue number:**
```typescript
await mcp__automagik_forge__update_task({
task_id: taskId,
title: "[๐] Bug: Clear description (#157)" // Add issue number
});
```
### When Starting Agent Sessions
**Format:**
```typescript
await mcp__genie__run({
agent: "implementor",
name: "[๐ค] implementor: fix-forge-base-branch",
prompt: "Fix base branch hardcoding..."
});
```
**Pattern:** `[<emoji>] <Agent>: <brief-description>`
**Note:** Agent session names are auto-generated by forge-executor.ts with correct emoji
## ๐ Decision Tree
**"Which emoji should I use?"**
### For Tasks
1. **Is it broken?** โ [๐] Bug
2. **New feature (planning)?** โ [๐ญ] Wish
3. **New feature (implementing)?** โ [โ๏ธ] Forge
4. **Research/investigation?** โ [๐] Learn
5. **Quality check?** โ [โ
] Review
6. **Clean up code?** โ [๐จ] Refactor
7. **Write docs?** โ [๐] Docs
8. **Maintenance?** โ [๐งน] Chore
### For Agent Sessions
1. **Which agent am I starting?**
2. **Find agent in emoji table**
3. **Use that emoji in brackets**
Example: Starting implementor โ [๐ค] implementor
## โ
Examples by Scenario
### Bug Fix Workflow
```
GitHub: [๐] Bug: Forge executor hardcodes base_branch
Forge: [๐] Bug: Forge executor hardcodes base_branch (#154)
Agent: [๐ค] implementor: fix-forge-base-branch-hardcoding
```
### Wish Workflow
```
GitHub: [๐ญ] Wish: MCP Server Authentication
Forge: [๐ญ] Wish: MCP Server Authentication (#152)
Agent: [๐ญ] wish: mcp-auth-discovery
[โ๏ธ] forge: mcp-auth-execution-plan
[๐ค] implementor: mcp-auth-endpoints
[โ
] review: mcp-auth-validation
```
### Learn Task
```
GitHub: [๐] Learn: Task Naming Convention Standardization
Forge: [๐] Learn: Task Naming Convention Standardization (#157)
Forge: [๐งน] Chore: Unified Emoji Naming Convention (updated from Learn to Chore per Felipe)
```
## ๐ซ Common Mistakes
### โ Wrong Format
```
Bad: Task 1: Forge Project Auto-Sync
Bad: ๐งน Chore: Missing brackets
Good: [๐งน] Chore: Forge Project Auto-Sync on MCP Startup
```
### โ Missing Issue Reference
```
Bad: [๐] Bug: Forge executor hardcodes base_branch
Good: [๐] Bug: Forge executor hardcodes base_branch (#154)
```
### โ Wrong Emoji
```
Bad: [๐] Bug: Add new authentication feature (not a bug!)
Good: [๐ญ] Wish: MCP Server Authentication
```
### โ Multiple Emojis
```
Bad: [๐๐ญ] Bug Wish: Something confusing
Good: [๐] Bug: Clear single-purpose title
```
## ๐จ Emoji Quick Reference (Copy-Paste)
```
Work Types:
[๐] Bug [๐ญ] Wish [๐] Learn [โ๏ธ] Forge
[โ
] Review [๐จ] Refactor [๐] Docs [๐งน] Chore
Execution Agents (Robots):
[๐ค] implementor [๐ค] tests [๐ค] polish [๐ค] refactor
Core Agents:
[๐ง] genie [๐ง] git [๐] release [๐] commit
[โ๏ธ] prompt [๐] debug [๐๏ธ] install
Thinking:
[๐ง ] analyze [๐ฏ] plan [๐ค] socratic [๐ฌ] deep-dive
[๐] explore
```
## ๐ Implementation Checklist
**When creating Forge tasks:**
- [ ] Choose emoji from work type table
- [ ] Format: `[<emoji>] <Type>: <Title> (#Issue)`
- [ ] Wrap emoji in brackets: `[๐]` not `๐`
- [ ] Verify title โค 80 characters (including brackets)
- [ ] Include GitHub issue number
- [ ] Same emoji across all systems
**When creating GitHub issues:**
- [ ] Choose emoji from work type table
- [ ] Format: `[<emoji>] <Type>: <Title>`
- [ ] Wrap emoji in brackets
- [ ] Add appropriate labels
- [ ] Update Forge task with issue number after creation
**When starting agent sessions:**
- [ ] Choose emoji from agent table
- [ ] Format: `[<emoji>] <agent>: <description>`
- [ ] Use robot emoji [๐ค] for execution agents
- [ ] Keep description brief and clear
- [ ] Auto-generated by forge-executor.ts
## ๐ Related Documentation
- **Full Spec:** `.genie/reports/emoji-naming-standard.md` - Complete taxonomy
- **Proposals:** `.genie/reports/task-naming-5-proposals.md` - How we chose emoji format
- **Mapping:** `.genie/reports/task-rename-mapping.md` - Before/after examples
## โจ Benefits
**Why emojis?**
1. โก **60,000x faster** visual recognition than text
2. ๐จ **Universal** - works across all platforms (GitHub, Forge, CLI)
3. ๐ **Scannable** - find tasks by visual shape, not reading
4. ๐ **Language-agnostic** - same meaning globally
5. ๐ฏ **Consistent** - one language everywhere
**Impact:**
- Faster kanban scanning
- Instant task type recognition
- Unified developer experience
- Reduced cognitive load
**Remember:** Same emoji = same meaning = same language everywhere ๐ฏ