Embarking on my open-source journey during Hacktoberfest was both thrilling and challenging. As a growing developer, this event provided me with a stimulating chance to explore the vast world of GitHub repositories and offer significant contributions. The vast amount of projects can be overwhelming for newcomers, but after careful exploration, I stumbled upon a project that caught my interest - Curio. I became interested in the Curio repository and will discuss my experience working on a particular issue for Curio in this blog post.
The Contribution
I decided to contribute by making improvements to the documentation after carefully considering the project. An issue had previously been created especially for documentation work. Acknowledging the significance of thorough documentation in any open-source project, I saw a chance to improve issue reporting and pull request submission through the creation of templates.
Crafting a Solution
To address the issue, I created two essential templates - one for reporting the issues and another for pull requests.
1.ISSUE_TEMPLATE.md:
---
name: Bug Report
about: Report a bug to help us improve
---
## Bug Report
**Describe the bug:**
A clear and concise description of what the bug is.
**To Reproduce:**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
**Expected behavior:**
A clear and concise description of what you expected to happen.
**Screenshots:**
If applicable, add screenshots to help explain your problem.
**Additional context:**
Add any other context about the problem here.
2.PULL_REQUEST_TEMPLATE.md
**Description:**
Describe your changes in detail.
**Issue:**
Closes # (if applicable)
**Type of change:**
- [ ] Bug fix
- [ ] New feature
- [ ] Code refactor
- [ ] Documentation update
**Checklist:**
- [ ] My code follows the style guidelines of this project.
- [ ] I have tested my changes.
- [ ] I have updated the documentation accordingly.
- [ ] My changes generate no new warnings or errors.
**Screenshots (if applicable):**
**Additional context:**
Add any other context about the pull request here.
These templates aimed to streamline the process for users contributing to Curio, ensuring that bug reports and pull requests follow a standardized format.
Reflections on the Contribution
Working on this issue was a valuable experience. It allowed me to delve into the project's documentation structure, understand the importance of clear and standardized contributions, and improve my skills in writing effective templates.
The collaborative nature of open source was evident throughout the process. Engaging with the Curio, receiving feedback, and ultimately having my pull request approved and merged (PR #85) was immensely rewarding.
Top comments (0)