Code Review with a Classmate
We had to review each other's class projects. I was always a fan of someone else reviewing my code, and it actually helped a lot this time, too.
What We Did
My classmate and I swapped GitHub links and looked at each other's Repository Context Packager tools. No meeting or anything, just clone the repo, try it out, and give feedback.
Looking at His Code
His project was in Python, mine was TypeScript. Pretty different approaches.
Good stuff:
- His code is easy to follow
- He handled file permission errors better
- The file tree output looked nicer with actual tree symbols
Problems I found:
- I don't think I should say it's a problem, but the package installer used is new to me, and I figured out how to go about it.
Testing it on different repos found bugs they missed. Made me realize I should test mine on more than just my own project.
Feedback on My Code
Which is very useful:
"Your README is missing npm run build." - Which was kind of embarrassing to forget that. My install instructions said:
git clone <repository-url>
cd repo-context-packager
npm install
But you actually need to run npm run build
or nothing works. I forgot because I was building it constantly while coding.
What I Learned
Having someone else actually use your code finds problems you miss.
Documentation is important. That missing build step would frustrate anyone trying to use my tool.
It's not just about finding bugs. Understanding why someone made different choices teaches you stuff.
Next Time
I'd do this earlier in the project. Getting feedback halfway through would be better than at the end when it's harder to change things.
Also going to double-check my README instructions by following them exactly on a fresh computer.
Overall
Code review was scary but worth it. Getting feedback from another student felt like working together to figure things out.
Top comments (0)