Michael's PR Emoji Guide

This is a guide to my PR emoji prefixes. Some of our engineers use these to great effect so I figured I'd start adding my own. This list is a combination of suggestions from coworkers and Brendan Forster [External].

Emoji Prefixes

🎨 :art: -- Non-Blocking / Nitpick code suggestions

• Context: This is a suggestion to improve the code, that shouldn’t affect the functional aspect but would help with readability/legibility
• Action: Contributor may want to accept the change (yay suggested changes), may provide extra context about why they’re not interested in making the change, or may just dismiss the suggestion
• Status: not a blocker on merging
• Synonyms from others: ⛳ (:golf:)

📝 :memo: -- Spelling / Grammar / Rewording / Phrasing

• Context: The wording here is a little unclear or I caught a small spelling mistake. This is a specific flavor of nit and usually accompanies 🎨.
• Action: Contributor may reword, correct spelling, etc.
• Status: not a blocker on PR approval but should be fixed before merging

♻️ :recycle: -- Case for reusable component

• Context: This seems like a prime candidate to extract this code into a reusable component
• Action: contributor may want to accept the change (yay suggested changes) or may provide extra context about why they’re not interested in making the change
• Status: tentatively a blocker on merging, pending discussion

🔧 :wrench: -- I think this needs to be changed

• Context: This section of code needs to be refactored and I'll suggest an alternative approach and/or implementation.
• Action: Contributor may want to accept the change (yay suggested changes) or refactor their code according to feedback
• Status: blocker on merging, pending discussion

💭 :thought_balloon: -- Thinking aloud

• Context: There’s something about this change that I’m thinking about, and it’s not currently clear to me whether something needs to change here
• Action: input about the questions or ideas proposed, and whether there is extra relevant information that I’ve overlooked
• Status: currently not a blocker on merging, pending further discussion

❓ :question: -- I have a question

• Context: I’m not clear about something
• Action: clarifying remarks from the contributor
• Status: tentatively a blocker on merging, pending more context

🚨 :rotating_light: -- I have concern(s)

• Context: I’m a bit nervous about this change and what it might introduce after merging, and would like to better understand why it is needed
• Action: discussion between contributor and reviewers
• Status: blocker on merging, pending further discussion
• Synonyms from others: 🚩

📌 :pin: -- Bigger issue

• Context: There's something out-of-scope in this current PR that should addressed in the future
• Action: discussion betwen contributor and reviewers, a jira ticket is created and linked to this comment/PR
• Status: not a blocker on merging