My Second PR for Hacktoberfest: A Journey of Finding and Fixing an Issue
Participating in Hacktoberfest has been a rewarding experience, and my second Pull Request (PR) taught me a lot. Here, I want to share how I found an issue, solved it, and what I learned.
Finding the Issue
I browsed repositories with the "Hacktoberfest" label on GitHub, filtering for "good first issue" or "help wanted". I found a basic static website project that had incorrect setup instructions in the README.md. The instructions mentioned running npm install, but there was no package.json file, making the step incorrect.
Fixing the Issue
I forked the repository, cloned it, and confirmed the problem. Since it was a static website, I updated the README.md to remove the npm install step and provided instructions to open index.html directly or use a simple local server.
I tested the changes, committed them with a clear message, and created a Pull Request explaining how my updates improved the setup process.
What I Learned
This PR taught me the importance of accurate documentation. Documentation is often the first touchpoint for contributors, and incorrect instructions can lead to confusion. By improving the README.md, I made the project more accessible, contributing to a welcoming open-source environment.
Hacktoberfest is not just about adding code—it's about making meaningful contributions. Even small improvements can significantly enhance user experience.
Top comments (0)