Be direct when making advisements on a code review
Be clear and concise.
Be straight to the point and clear about what you want changed or are advising. Don’t waffle on, beating around the bush simply state the What and Why.
Most git systems these days allow you to click on the line you wish to be changed , and add a comment so it’s much simpler to specify the exact line of code you want changed.
Hosting providers such as GitHub have a “suggestion” feature which allows you to add a code suggestion directly into the comment, which can instantly be accepted and committed from within the PR. (View Highlight)
- Don’t beat around the bush. Saying what and why you are advising changes will be more of value than trying a long winded explanation.
Additional Metadata
- Type:: note
- Origin:: My Opinion on What Makes a Good Code Review.
- Tags:: Code Review