UNPKG

@namastexlabs/speak

Version:

Open source voice dictation for everyone

304 lines (233 loc) โ€ข 8.03 kB
# ๐ŸŽจ 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 ๐ŸŽฏ