Hacktoberfest: Help redesign our CONTRIBUTING guidelines

[monozoide]

We’re overhauling our CONTRIBUTING guide to make it clearer, kinder, and more enforceable.

This thread is the single place to propose changes, discuss trade-offs, and converge on a final draft that we’ll merge as CONTRIBUTING.md

@NssGourav I'll work on a first version soon and post it here. But in the meantime, as a new contributor, how did you perceive your first contribution to this project compared to your other experiences?

I invite you to share your feedback and questions.

[NssGourav]

Hey @monozoide!
My first experience contributing here was pretty smooth and welcoming. The README and docs are super detailed which helped a lot.
That said, it took me a little time to figure out like PR steps branch naming, and commit style.

I think the new CONTRIBUTING guide could be awesome if it included a simple step-by-step workflow like a quick “first PR” example, and tips for the optional features.

Excited to see the draft and happy to help review it :)

[monozoide]

Thanks for your feedback!

So yes, I admit that the project's start was a bit chaotic, in the sense that I didn't take the time to properly clarify the workflows.

Hacktoberfest allows me to identify areas for improvement.

In my opinion, regardless of a contributor's level of expertise, it's important that the maintainer of an open source repository provides clear and precise guidelines on how they would like to work with others.

Even though, overall, the standards are there to define a framework, each maintainer has their own subtleties that they must clarify in order to facilitate the work of contributors and encourage them to participate in the project.

This allows the contributor to focus on what's important and avoid wasting time trying to figure out how to do things.

So, I'm thinking of dividing the contribution rules into two parts:

1. Short version: visible in the Contribution tab of the repository homepage, it summarizes the important points as much as possible while retaining the essentials.
2. Long version: in the docs folder, it goes into more detail about the workflows.

I've attached both versions. Let me know what you think, and feel free to modify/correct them if necessary.
If anything isn't clear, let me know!

Thanks in advance.

CONTRIBUTING.md
CONTRIBUTING_DETAILED.md

[NssGourav]

okay i'll let you know
presently my Undegradute exams are going on i'll check them again and revert soon..

[monozoide]

Good luck with your exams 🥇

[NssGourav]

Thanks 😄