- I have run and tested my changes locally
- I have limited this PR to less than 1000 lines of code change (if not, explain why)
- I have updated/added tests to cover my changes (if applicable)
- I have updated/added requirements to cover my changes (if applicable)
- I have run linting and formatting on any code changes (if applicable)
- I have updated the documentation (README, etc.) accordingly
: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. |
| ⭐⭐⭐ | :star: :star: :star: |
Important to fix before PR can be approved... And I am providing reasons why it needs to be addressed as well as suggested improvements. |
| ⭐⭐ | :star: :star: |
Important to fix but non-blocking for PR approval... And I am providing suggestions where it could be improved either in this PR or later. |
| ⭐ | :star: |
Give this some thought but non-blocking for PR approval... ...and consider this a suggestion, not a requirement. |
| ❓ | :question: |
I have a question. This should be a fully formed question with sufficient information and context that requires a response. |
| 📝 | :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. |