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
The current contribution documentation could be more comprehensive to better guide contributors. The documentation outlines key information such as the project structure but lacks detailed guidelines on key aspects like creating issues, submitting pull requests, and reviewing contributions.
A robust contributing guide could include:
Clear instructions on how to create and label issues.
Steps for getting an issue assigned and starting work on it.
Guidelines for submitting pull requests, including linking issues and avoiding force-pushes.
A section on effectively reviewing pull requests with DOs and DON'Ts.
The project also does not have an established Code of Conduct. Implementing one could be highly beneficial in creating a safe, inclusive, and respectful environment for all contributors. I suggest adopting something similar to the Contributor Covenant Code of Conduct, which has been widely recognised and successfully implemented in many OSS projects.
An example would include the following topics:
Our Pledge
Our Standards
Enforcement Responsibilities
Scope
Enforcement guidelines
Adding such detailed information will help new contributors get up to speed faster and, maintain consistency and quality in their contributions.
The link for CODE_OF_CONDUCT in README.md is also broken.
Please give feedback on this when you find the time and if approved, assign me the issue
Thanks!
The text was updated successfully, but these errors were encountered:
YTeyddie22
changed the title
Updating Contribution.md
Update Contribution.md
Aug 22, 2024
The current contribution documentation could be more comprehensive to better guide contributors. The documentation outlines key information such as the project structure but lacks detailed guidelines on key aspects like creating issues, submitting pull requests, and reviewing contributions.
A robust contributing guide could include:
The project also does not have an established Code of Conduct. Implementing one could be highly beneficial in creating a safe, inclusive, and respectful environment for all contributors. I suggest adopting something similar to the Contributor Covenant Code of Conduct, which has been widely recognised and successfully implemented in many OSS projects.
An example would include the following topics:
Adding such detailed information will help new contributors get up to speed faster and, maintain consistency and quality in their contributions.
The link for CODE_OF_CONDUCT in README.md is also broken.
Please give feedback on this when you find the time and if approved, assign me the issue
Thanks!
The text was updated successfully, but these errors were encountered: