Skip to content

Conversation

@SachinRajakaruna
Copy link

🎯 Summary

This PR adds a new "HACKTOBERFEST.md" file to make the repository more welcoming and accessible to contributors participating in Hacktoberfest.

The document provides a clear, friendly, and professional overview of:

  • What Hacktoberfest is and how to get started with this project
  • Step-by-step contribution workflow (fork, branch, commit, PR)
  • Git best practices, formatting guidelines, and example commit messages
  • Tips to write high-quality, meaningful pull requests
  • Encouragement and recognition for contributors

💡 Why This Matters?

This addition significantly improves the contributor experience - especially for first-time open-source participants.
It helps maintainers receive cleaner PRs, reduces review time, and fosters a more positive community environment around this project.

In short:

  • New contributors feel guided and welcomed
  • Maintainers get better-structured submissions
  • The project gains visibility and community engagement during Hacktoberfest

🧩 What’s Included?

  • "HACKTOBERFEST.md" (comprehensive contribution guide)
  • Friendly tone consistent with open-source community standards
  • Alignment with repository’s purpose and structure

✅ Checklist

  • Added detailed and friendly contributor guide
  • Maintains repository consistency and markdown format
  • No code or dependency changes introduced
  • Verified file readability and clarity

🙌 Final Note:

This PR focuses on strengthening community participation and sustainability of this repository.
It’s written with care to reflect the project’s open, welcoming spirit and to make Hacktoberfest contributions more enjoyable for everyone.

Looking forward to your feedback - and hoping this addition helps both maintainers and contributors throughout Hacktoberfest and beyond! 🎉


Thank you for reviewing this pull request.
Happy Hacktoberfest.

@hhkaos
Copy link
Member

hhkaos commented Oct 16, 2025

Thanks @SachinRajakaruna for the PR.

I think some of the content in your PR can be repurposed to enhance CONTRIBUTING.md, but I don't think it makes sense to have two different contributing guidelines.

For example, info in the "💡 What You Can Contribute?" and "🧭 How to Get Started?" could be added.

We have an open issue to improve CONTRIBUTING.md #1; however, the information there likely exceeds the scope of this contribution.

For your reference, there is a similar repository with a CONTRIBUTING.md file that features an enhanced structure, which we can use as inspiration for this one.

@hhkaos
Copy link
Member

hhkaos commented Nov 9, 2025

@SachinRajakaruna are you still interested in this PR or should we close it?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants