A simple emoji legend to help convey intention and added meaning in code review comments.
A picture is worth 1,000 words.An emoji is worth 20 words.
A little bit of emoji can go a long way when it comes to code reviews and make giving and receiving code review a little bit more enjoyable 😃.
Using CREG (Code Review Emoji Guide) puts more ownership on the reviewer to give the reviewee added context and clarity to follow up on code review. For example, knowing whether something really requires action (🔧), highlighting nit-picky comments (⛏), flagging out of scope items for follow-up (📌) and clarifying items that don’t necessarily require action but are worth saying ( 😃, 📝, 🤔 )
:code: |
Meaning | |
|---|---|---|
| 😃👍💯 | :smiley: :+1: :100: |
I like this... ...and I want the author to know it! This is a way to highlight positive parts of a code review. |
| 🔧 | :wrench: |
I think this needs to be changed. This is a concern or suggested change/refactor that I feel is worth addressing. |
| ❓ | :question: |
I have a question. This should be a fully formed question with sufficient information and context that requires a response. |
| 🤔💭 | :thinking: :thought_balloon: |
Let me think out loud here for a minute. I might express concern, suggest an alternative solution, or walk through the code in my own words to make sure I understand. |
| 🌱 | :seedling: |
Planting a seed for future. An observation or suggestion that is not a change request, but may have larger implications. Generally something to keep in mind for the future. |
| 📝 | :memo: |
This is an explanatory note, fun fact, or relevant commentary that does not require any action. |
| ⛏ | :pick: |
This is a nitpick. This does not require any changes and is often better left unsaid. This may include stylistic, formatting, or organization suggestions and should likely be prevented/enforced by linting if they really matter |
| ♻️ | :recycle: |
Suggestion for refactoring. Should include enough context to be actionable and not be considered a nitpick. |
| 🏕 | :camping: |
Here is an opportunity, not directly related to your changes, for us to leave the campground [code] cleaner than we found it. |
| 📌 | :pushpin: |
This is a concern that is out of scope and should be staged appropriately for follow up. |
Prepend comments with the appropriate emoji to convey the meaning associated with it. Combine emoji for added fun.
🔧 We have an existing module,
great-module.js, that accomplishes this same task. Let's pull it in and replace your implementation with it.
♻️ This section of code feels like it could be extracted nicely into a separate module. I feel like that would create clearer boundaries and increase readablity here.
🔧 ♻️ This method feels overly verbose and I can see can that we can simplify this approach by [DOING X]. I think this should be refactored before we merge this feature and this becomes a permanent pattern in our codebase.
⛏ These intermediary variables and if statements could be simplified down to a single ternary expression.
😃 Wow, I would never have thought of that myself. Swell work!
🌱 I've been meaning to explore library X which claims to solve this exact problem. That could be worth exploring and peeking under the hood to see what concerns they are specifically addressing.
📌 We really need to invest some time in refactoring out our use of this deprecated library. Issue created: [LINK TO ISSUE].
Partially inspired by