DEV Community

Discussion on: Code Review Checklist (Brain Backup/Export)

Collapse
 
tinussmit profile image
Tinus Smit

That is quite the list you've got there. It's not 100% clear to me how you use it in code review... Do you categorize comments into these?

If that's the case, I've adopted a similar style, but with fewer categories.

  • Convention
    • Naming conventions, patterns, process, etc.
  • Error
    • Blatant error in code / logic / understanding.
  • Logic
    • Purpose of the code is not clear from simply reading it.
  • Simplify
    • Opportunity to refactor code into a method or replace code with framework method.

I use these as prefixes to my comment, so that it's rather easy to infer the sentiment behind the comment which follows.

Perhaps mine is too simple, but I've found it works for much of the time spent reviewing code :)

I like your expanded list, and I might adopt a few when the opportunity presents itself :)

Collapse
 
tomerbendavid profile image
Tomer Ben David

Thanks I like that yours is categorized and concise. The way I use mine is more like as a general intuition snapshot reminder, I just scan it for a few seconds from time to time and when i get to code review some things from the list pop up and i use them. We could call it brain-pop-up-list to scan fro m time to time. ;)

Collapse
 
tinussmit profile image
Tinus Smit

Ah, I see now. It's not so much the comments itself as it is the things you are looking at when reviewing code.

In that case, this is quite handy. I do bear a lot of these in mind when reviewing code, but it is quite implicit in my mind already; many years of doing this sort of thing just does that :-)

But I'm actually about to introduce a code review process at a new company, and this would help explain to the rest what to look out for.

Great post!