Skip to content

Instantly share code, notes, and snippets.

@nicoolas25
Last active June 2, 2023 12:19
Show Gist options
  • Star 6 You must be signed in to star a gist
  • Fork 3 You must be signed in to fork a gist
  • Save nicoolas25/bbc2baf760e273e069361d0e1383587f to your computer and use it in GitHub Desktop.
Save nicoolas25/bbc2baf760e273e069361d0e1383587f to your computer and use it in GitHub Desktop.
Legend for my PR 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: 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: 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.
πŸ’‘ :bulb: This is something I didn't know about and 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 fo thoughts.

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

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

Credits

Duplicates https://github.com/erikthedeveloper/code-review-emoji-guide

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