swaraj-das/Collect-your-GamingTools

[DOCS] Creation of dedicated CONTRIBUTING.md file.

Closed this issue · 2 comments

Issue Description

There is currently no dedicated file for contributors, such as a CONTRIBUTING.md. Instead, the documentation for the project and the contributors is mixed within the README.md file, which reflects poor documentation practices.

Screenshots or Examples (if applicable)

image

Proposed Solution (optional)

I want to create a dedicated file for contributors [CONTRIBUTING.md] so they can review the details of the contribution procedure. I believe that keeping the README.md focused on the project description will enhance the overall quality of the documentation. Additionally, I plan to support new contributors by providing a few git commands and outlining the structure they should follow to contribute to the repository effectively.

Checklist

  • I have checked the existing issues.
  • The changes don't break the code
  • Please attach the screenshots and video of the development work once it is done

@swaraj-das Will you close the issue or should I close it?

Closing the issue since it has been resolved and merged in the following PR #127.