This content originally appeared on DEV Community and was authored by OleksandraKordonets
For my first Hacktoberfest contribution, I worked on Issue #3 in the NIRMAAN repository. The issue was about creating a proper README for the project, since the repository initially didn’t have one.
Since this is my first time participating in Hacktoberfest, I decided to look for issues labeled “good first issue” so I could familiarize myself with open source contributions without feeling overwhelmed. I wanted something manageable but still meaningful, and the README issue seemed like a good fit.
To get started, I basically followed the usual steps I’d take when contributing to someone else’s project. I forked the NIRMAAN repo to my own GitHub account, then created a new branch locally for the issue. I cloned my fork to my computer, went through the project structure, and then created the README file. After finishing the changes, I committed them, pushed the branch to my fork, and finally submitted a Pull Request from my branch to the original repository. This is a pretty basic scenario of actions, as we’ve done this several times in previous labs.
Even though NIRMAAN isn’t super big, I spent some time reviewing it even before taking on the task. I didn't want to get started just to discover that the project was too complicated or that I didn't fully comprehend how it worked. Going through the repo beforehand helped me feel more confident. Despite that, creating the README was a nice task, as it allowed me to practice my Markdown skills and organize the project documentation clearly.
This content originally appeared on DEV Community and was authored by OleksandraKordonets
OleksandraKordonets | Sciencx (2025-10-03T00:32:05+00:00) Hacktoberfest Contribution: README Creation. Retrieved from https://www.scien.cx/2025/10/03/hacktoberfest-contribution-readme-creation/
Please log in to upload a file.
There are no updates yet.
Click the Upload button above to add an update.