Skip to content

Instantly share code, notes, and snippets.

@tchapi
Created September 29, 2022 18:13
Show Gist options
  • Save tchapi/d2a748e0e30a945245f0875e67fee5a4 to your computer and use it in GitHub Desktop.
Save tchapi/d2a748e0e30a945245f0875e67fee5a4 to your computer and use it in GitHub Desktop.
Comprehensive legend for my PR review comments
:code: Meaning
πŸ‘πŸ’―πŸ˜ :+1: :100:, :heart_eyes: 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 question, a concern, or suggested change/refactor that I feel is worth addressing before approving.
❓ :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: Here's a note

This is an explanatory note, fun fact, or relevant commentary that does not require any action.
♻️ :recycle: Suggestion for an optional refactoring

Should include enough context to be actionable and not be considered a nitpick.
πŸ• :camping: Opportunity

Here is an opportunity, not directly related to your changes, for us to leave the campground [code] cleaner than we found it.
πŸ“Œ :pushpin: Don't forget

This is a concern that is out of scope and should be staged appropriately for follow up.
πŸ’‘ :bulb: I didn't know that!

This is something I'm learning thanks to the author and the review.
⚠️ :warning: I noticed something that might be an error

I trust the author to dig deeper on this or dismiss it if non-relevent.
πŸ– :meat_on_bone: Food for thoughts

Do what you want with it but it's totally okay to dismiss it.

It could be about how I would have done this or that, external references, and so on.

Credits

Taken from Nicolas Zermati's legend: gist

Also duplicates the Code Review Emoji guide from Erik Aybar

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment