DEV Community

Rachit Chawla
Rachit Chawla

Posted on

A Collaborative Learning Experience: Code Review and Issue Resolution

Hello everyone,

I recently had the opportunity to participate in a lab that involved collaborating with my classmates on a coding project. The assignment was simple yet immensely valuable: we were tasked with reviewing each other's code and providing at least five suggestions or issues for improvement. In return, our peers did the same for our projects. This experience not only strengthened our coding skills but also fostered a sense of community and collaboration within our class.

Crossing Language Boundaries

One of the most interesting aspects of this assignment was the diversity of programming languages we encountered. For instance, my assigned project was written in TypeScript, a language I wasn't particularly familiar with, while my partner had limited experience with Python, the language I had used. This presented a unique opportunity for both of us to learn and teach each other.

Helping Each Other Grow

I took the initiative to review my partner's TypeScript project and suggested five changes. Two of these were bug fixes, while the other three focused on enhancing the project's README file. I also had the chance to assist my partner in improving their README, as they were working with Markdown for the first time. It was a rewarding experience to see how a few simple improvements could make a project more accessible and user-friendly.

Challenges in My Repository

When it came to my own project, I encountered some issues as well. These included fixing a typo, adding requirements to my README to ensure users had the necessary tools (Python and a bash/zsh terminal), and resolving an issue related to paragraph parsing when there were multiple empty lines.

The most enlightening lesson I learned during this process was the importance of referencing issue numbers in commit messages. This simple practice created a direct link between my code changes and the issues I was addressing, making it easier to track progress and communicate with collaborators.

I'm pleased to report that I successfully addressed all the issues in my repository and closed them. It was a gratifying feeling to see my project improve with the help of my peers' feedback and my own dedication to continuous improvement.

Links to the Issues

For those interested, here are the links to the issues I filed for my classmates' projects and the issues I encountered in my own repository:

Issues I Filed for Classmates' Projects: Link

Issues I Faced in My Repository: Link

Top comments (0)