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

Update README.md Contribution.md and CODE_OF_CONDUCT.md #9

Open
YTeyddie22 opened this issue Aug 22, 2024 · 0 comments · May be fixed by #11
Open

Update README.md Contribution.md and CODE_OF_CONDUCT.md #9

YTeyddie22 opened this issue Aug 22, 2024 · 0 comments · May be fixed by #11

Comments

@YTeyddie22
Copy link

YTeyddie22 commented 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:

  • 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!

@YTeyddie22 YTeyddie22 changed the title Updating Contribution.md Update Contribution.md Aug 22, 2024
@YTeyddie22 YTeyddie22 linked a pull request Sep 28, 2024 that will close this issue
@YTeyddie22 YTeyddie22 changed the title Update Contribution.md Update Contribution.md and CODE_OF_CONDUCT.md Sep 28, 2024
@YTeyddie22 YTeyddie22 changed the title Update Contribution.md and CODE_OF_CONDUCT.md Update README.md Contribution.md and CODE_OF_CONDUCT.md Sep 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant