Courses
Videos
Discussions
Events
Networking
Login
Join Taro Premium
3.2K
3.2K Views
121 Likes
What A Test Plan Is And Why Every Code Review Needs One
Core points:
Actually show that your code works when you submit your code for review. You do this with something called a "test plan".
Be visual if you can. The best thing to attach is a video or a .gif. A step down is attaching a screenshot.
If you're working on APIs, you can attach a screenshot of a curl or Postman
Whatever you're doing to verify that your code works, capture that in your test plan
Benefits of having a test plan:
Basic trust token showing your teammates that your code works, at least in the core flow
Turns your code review into a much more informative and self-documented piece of codebase history
Makes it far easier for people not to break whatever is in your code review when they work with it in the future
Show a repeatable way to test your change
If you're adding automated tests, include the command to run it
With a video, show the full process of triggering the flow altered by the commit (e.g. tapping into a certain screen on a website)
Related resources:
Concrete example of what a good test plan looks like (with GitHub link)
One Diff, One Thesis - What Every Code Review Should Be Like
"How can I write great code faster?"
Avoid These Junior Engineer Mistakes With Code Review
Clipped From Main Video
👑
1:31:49
[Masterclass] How To Do Amazing Code Review
Related Videos
👑
5:48
Figuring Out What Matters In A Codebase
👑
7:27
How To NOT Learn A Codebase
👑
10:07
Level Up Your Code Quality As A Software Engineer [Part 26] - Side Projects & Open-Source
👑
8:55
Level Up Your Code Quality As A Software Engineer [Part 19] - Code Review Feedback
👑
11:33
Level Up Your Code Quality As A Software Engineer [Part 18] - Have A Test Plan
👑
8:52
Level Up Your Code Quality As A Software Engineer [Part 17] - Share The Context
👑
10:15
Level Up Your Code Quality As A Software Engineer [Part 16] - One Diff, One Thesis
👑
8:01
Level Up Your Code Quality As A Software Engineer [Part 13] - Lay Out The Plan
47:06
Paper Reading Session: Simple Testing Can Prevent Most Critical Failures
👑
1:14:02
[Masterclass] How To Stop Writing Messy Code As A Software Engineer
Explore company
Amazon
Google
Meta
Microsoft
Netflix
Airbnb
Explore level
Entry-level
Mid-level
Senior
Staff
Explore trending
Layoffs
Performance Improvement Plan
System Design
Interpersonal Communication
Tech Lead
Referrals: Earn $100
•
Blog
•
Featured Questions
•
Perks
•
Topics
•
Privacy Policy
•
Terms & Conditions
Copyright © Taro