[DOCS]: Merge README and CONTRIBUTING.md - Githubissues

rubyforgood / human-essentials

Human Essentials is an inventory management system for diaper, incontinence, and period-supply banks. It supports them in distributing to partners, tracking inventory, and reporting stats and analytics.

https://humanessentials.app

MIT License

446 stars 473 forks source link

[DOCS]: Merge README and CONTRIBUTING.md #4447

Closed jimmyli97 closed 3 months ago

jimmyli97 commented 3 months ago

Is there an existing request for this change?

[X] I have searched the existing issues

Context for documentation change

Documentation has some conflicts which are a bit confusing to new contributors like me:

README has contributing guidelines duplicated in CONTRIBUTING.md
README says to run rubocop -a, CONTRIBUTING says to run bin/lint
Pull request text says to run bundle exec rake while other places it says to run bundle exec rspec
Dead links in sbv.md

Proposed solution

Put all contributing information from README into CONTRIBUTING.md, link to CONTRIBUTING.md from README
Use bin/lint instead of rubocop -a, bundle exec rake instead of bundle exec rspec before submitting pull request
Fix dead links in sbv.md
Add note that workflows will run bin/lint and rspec when submitting pull requests

Resources that can help

No response

Collaborators

No response

Code of Conduct

[X] I've read the Code of Conduct and understand my responsibilities as a member of the Ruby for Good community