DEV Community

Sam Jarman 👨🏼‍💻
Sam Jarman 👨🏼‍💻

Posted on

100 Bytes Of Wisdom: Day 18 - more code review wisdom!

Alt Text

I love advising the teams I work with to attach visual proof to code review. Not only does it give context (more on that in my next byte) but it means you've actually run the code, seen it works and compared it with your own expectation or mocked design. Visual proof doesn't have to be only for front ends, it could be a screenshot of some logs, or some graphs, anything.

The benefit here is two-fold.

First, you are proving to your reviewers you did the task and the code works. I've even found bugs as I recorded a demo record a small demo or took a screenshot. Use the demo gods for good!

Second, you're having your reviewers review what you think the proof is. Is what you've done enough to solve the task? Are you observing the right output to come to the conclusion that you are finished? This is another great chance to collaborate with a reviewer.

Heads up: As with any terse bit of advice, there will be exceptions of course, and subtleties and nuance that can't possibly be captured in a Byte of Wisdom. This has been what I've experienced, I'd love to hear yours in the comments too!

You can catch up with all the other bytes at http://bytesofwisdom.com/

Discussion (0)