You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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)
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.
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)
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
The text was updated successfully, but these errors were encountered: