Join Taro Premium
Courses
Jobs
Discussions
Events
Login
Join Taro Premium
3.3K
3.3K Views
122 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
👑
7:10
Become An Open Source Master [Part 22] - Good Practices When Making Commits
👑
3:59
Become An Open Source Master [Part 19] - What Opinions Do The Authors Have?
👑
2:55
Grow From Junior To Mid-Level Engineer [Part 7] - Code Review
👑
3:21
Asking Great Questions [Part 15] - RFC Pull Requests
👑
5:28
How To Be An Effective Tech Lead [Part 6] - Be The Code Guardian
👑
7:10
[Timeless Career Advice] How Software Engineers Use Code
👑
9:16
Grow From Mid-Level To Senior Engineer [Part 10] - Code Review
👑
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
Explore Companies
Amazon
Google
Meta
Microsoft
Netflix
Airbnb
Explore Levels
Entry-Level
Mid-Level
Senior
Staff
Explore Trending
Layoffs
Performance Improvement Plan
System Design
Interpersonal Communication
Tech Lead
Product
Referrals: Earn $50
Featured Questions
Perks
Topics
Company
Blog
Privacy Policy
Terms & Conditions
Support
Copyright © Taro