All learning paths Learn See Try Make Write a review the author can act on What this lesson is about Point at one line, name the rule it breaks, and say what to write instead. Nothing else belongs there.
An answer you are reviewing swallows an error in one place, and the author is waiting. What do you send back?
A Write that the error handling is weak and the naming could be clearer. B One comment names one line, one rule, and what to write instead. C Send the line number and the rule it breaks, and let him work out the fix.
Check my recall Why this matters A review is paid for what the author can do with it. A comment that names a line and gives the replacement can be applied straight from the review page. A comment that says the code could be better costs a reply and a day.
Write review comments an author can apply the same day, without writing back to ask.
A review is paid for what the author can do with it. A comment that names a line and gives the replacement can be applied straight from the review page. A comment that says the code could be better costs a reply and a day.
One comment names one line, one rule, and what to write instead. Separate what must change from what you would have done, and label which. Write it so the author can act without asking you what you meant. Task Write three review comments on one answer for an evaluation project.
Weak approach Writes that the error handling is weak and the names are unclear. The file would read better in smaller pieces. No line number appears in the three comments.
Stronger approach Comment one: line 22 swallows the error — write raise ValueError(msg) there. Comment two: rename n to row_count. Comment three is labelled taste: split the loop.
Why the stronger approach works The weak set names no line and no replacement. The strong set can be applied, and labels the one that is only taste.
Try a changed situation You are reviewing a school student's first program. Half your notes are real faults and half are your own habits. How do you send them?
Make something yourself Review one answer with three comments. Each names a line, the rule it breaks, and the exact replacement. Label any comment that is your taste rather than a fault.
Lesson 10 of 10 on Coding for evaluation work next What an agent actually does Part 3 ends in a work sample you can send The rules this work sample is read against, with a worked example
Read the primary or official source: GitHub Docs · Commenting on a pull request