Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] Creation of dedicated CONTRIBUTING.md file. #117

Closed
3 tasks done
rajdeepchakraborty-rc opened this issue Oct 4, 2024 · 2 comments
Closed
3 tasks done

[DOCS] Creation of dedicated CONTRIBUTING.md file. #117

rajdeepchakraborty-rc opened this issue Oct 4, 2024 · 2 comments

Comments

@rajdeepchakraborty-rc
Copy link
Contributor

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
@rajdeepchakraborty-rc
Copy link
Contributor Author

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

@rajdeepchakraborty-rc
Copy link
Contributor Author

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

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

No branches or pull requests

2 participants