DOCS UPDATE: CONTRIBUTING.md

[ShivamQmr]

Is this related to an existing part of the documentation?

• Yes, it is related to an existing section

What needs to be updated?

📌 Current Documentation Issue

Current guide for new Contributors are not well-documented. Even the link in the Readme file for Contributing Guidelines shows 404 error.

✨ Proposed Changes

I would suggest to update Readme file with contributing guidelines.

📋 Additional Context

Although I can take the opportunity to update the CONTRIBUTING.md by following other prominent project's docs, I would really appreciate if any current maintainers make this update as they are more clear with the directives of contribution.

Relevant Documentation Link (if any)

https://github.com/AOSSIE-Org/Devr.AI/blob/main/README.md

Record

• I agree to follow this project's Code of Conduct
• I want to work on this update

[smokeyScraper]

Hey @ShivamQmr,
The README was recently updated, and I don't think there's any as such need to re-update it. Please mention if you faced any problems with the current README. The new installation guide now even has a video setup guide for the repository.

However, I can't deny that we still require a CONTRIBUTING.md. Thanks for that. For that, I'll update it myself with the instructions and steps the organization holds, and what I prefer for the contributors while contributing to Devr.AI.

[ShivamQmr]

Thanks for the response @smokeyScraper !

I am sorry for the phrase "Current guide for new Contributors are not well-documented. Even the link in the Readme file for Contributing Guidelines shows 404 error."
It was rude to be honest 😅. It's better to say "Contributing section of Readme has can be improved for new contributors, and Contributing Guidelines needs to be updated."

The specific place where I messed up was the Contributing section of Readme. There was no installation or setup instructions, and I assumed the Getting Started section is for general usage. I think parenting them under the Contributing section will help a lot. Adding sentence maybe in Development Setup saying that you can follow the getting started section to setup the project locally will sweep a lot of confusions for newbie.

Yeah, but the video was really in the installation guide was really helpful to go through.