What would you want to know about this code?

As I'm working on a feature, I'll keep notes on any decisions I make, especially if my first idea ended up not working, and I had to try something else.

Then, when I go to submit the code for review, I'll include those notes along with the general feature description.

That's just one example of how I try to anticipate questions the reviewer might have.

Other examples where you might anticipate a question:

• Code that seems more complex than it needs to be - explain why a simpler approach didn't work
• A validation rule that might seem too strict - make the business case for it
• Any deviation from the project's normal conventions - why this is different

The list could go on and on. But why bother with this?

Just think, if you were reviewing this code, what would you want to know about it?

If you were looking at it for the first time, what would confuse you?

Anticipating these questions will not only make the review go more smoothly, but it is a good final check that you designed the code intentionally before submitting it for review.

Here to help,

Joel

P.S. Do you work alone and don't have someone to review your code? Getting an expert code review is one of the best ways to level up your skills. Schedule a call to get started.