DEV Community

WH yang
WH yang

Posted on

The experience of reporting an issue on Github - OSD Lab 1

I fork my classmate's project and clone it to my account to review it. Forking makes sure I don't accidentally change the original project.

I followed the installation instructions in the README.md file, and everything worked fine. This confirmed that the README.md is accurate, but since nothing went wrong, I felt like I hadn’t done a thorough job. So, I started testing all the options and checking if the outputs matched the expected results. Eventually, I noticed some outputs didn’t align with the requirements. Honestly, I find testing boring, and I imagine the project owner feels the same way.

The -v option wasn’t working, but -V was. However, this doesn’t match our requirements. I suspect the repo owner forgot to override the library’s default option.

My classmate shared an issue that I wasn’t aware of. The method he used to reproduce the issue wasn’t part of my testing process. If he hadn’t told me, I would have never discovered it.

I plan to fix all the issues reported in my repo since they highlight missing features. I’m glad my classmates reviewed my project early on, as it helped me discover problems I wasn’t aware of. Having community support during development feels very encouraging.

Top comments (0)