Skip to content

Latest commit

 

History

History
88 lines (46 loc) · 2.2 KB

shorthand.md

File metadata and controls

88 lines (46 loc) · 2.2 KB

Shorthand

This pages explains what the emojis used in code-review comments and Slack mean. They are shorthand for common situations.

In code review comments

💬 - debug code...

Debug/commented-out code needs removing/uncommenting

👻, 🕵🏾, 🐼 - pedantry...

Minor/pedantic point - short hand for:

"I know this is deeply pedantic but..."

For comments so pedantic you're almost embarrassed to write them, wrap in <sup> tags.

🐼"Direct Debit" should be title-case.

"Panda-ntic" if you will.

👀 - please look at this...

Please eyeball this change/commit/code:

👀 Hey @team, is this change OK? I'm not that familiar with $domain_concept

♻️ - same as above...

Same explanation as above (a.k.a. ditto).

🐂, 🐃 - out-of-scope, but...

Yak-shaving code review comments, as in:

I know this is out of scope for this PR request but...

or something like:

I know you only renamed the file but I'm going to comment on all the green lines in the diff that you didn't write...

🚗 - passing through

For a "drive-by" comment:

I’m just passing through and I haven't done a full review but noticed that...

🙌 - praise

For highlighting something positive in the pull request

🙌 Nice catch!

❓ - question

When you have a potential concern but are not quite sure if it's relevant or not

❓ Is this condition possible in the real world?

🤔 - suggestion

Use when you want to propose improvements to the current subject

🤔 I think you should consider moving this to the domain layer

🍷🧀 - tasting notes

Used to indicate that a self-review provides additional context and commentary on the changes. Possibly including a recommendation for how to review it (like the tasting notes on a fancy bottle of wine or fine cheese)

In Slack

👀 - "I'm looking at that now"

✅ - PR approved

🏓 - "I've requested changes" or "I've responded to your feedback" (back to you...)

💬 - comments added

🚢 - PR merged (a.k.a. shipped)

🏀 - PR can be merged immediately after passing review (i.e. a "slam dunk" or, more accurately, an "alley oop")

🦆 - I'm "ducking out" (i.e. going to be away from the keyboard for a bit)