Contributing to Hacktoberfest: Adding a README.md to the SenecTask API Server
As part of Hacktoberfest 2025, I decided to contribute to an open-source project to help improve documentation and make it easier for new contributors to get started. I chose the eventServer repository, a Node.js API server for SenecTask, which is a collaborative task and event management platform for Seneca Polytechnic users. I'll walk through my contribution process, the issue I addressed, the pull request I created, and some reflections on what I learned.
The Issue: Missing Documentation
The first went through the repository and noticed it lacked a comprehensive README.md file. Without clear setup instructions, API documentation, or contribution guidelines, new developers would struggle to understand the project, run it locally, or contribute effectively.
I filed issue-18 to highlight this and it addressed a real need, that of improving project discoverability, reducing barriers for contributors.
The Process: Drafting and Implementing the README.md file
I started by exploring the entire codebase. I read through the existing files to understand the project's structure and functionality. The app is a Node.js/Express server using MongoDB with Mongoose, bcrypt for security, and Jest for testing. It handles user signup with email validation and plans for event or task management.
Submitting the Fix
Once the README was ready, I committed it to a new branch and pushed it. Then, I opened a pull request targeting the main branch. The PR description summarized the changes, linked to the issue (closing it), and included a checklist for the repository owner.
Lesson Learned and Reflections
This contribution was a great experience! I once more learned how to navigate GitHub issues and PRs effectively, from filing an issue to drafting a PR description that closes it. I also improved my Markdown skills. Understanding the project's codebase (e.g., how signup works with email validation) deepened my appreciation for secure backend development.
Starting small with documentation is low-risk and high-impact. It builds confidence and helps the community. Next time, I'd explore adding tests.
Overall, contributing to eventServer was rewarding. It not only helped the project but also boosted my open-source skills. If you're participating in Hacktoberfest, I highly recommend starting with docs or small fixes as they're often the most needed and appreciated.
Top comments (0)