Update README.md and Contributing.md

[AzaniaBG]

Overview

We need to update the PeopleDepot README.md file for potential new members attending the PeopleDepot workshop. We will use the website team's Contributing Guide to supplement the PeopleDepot guide.

Action Items

• Add a section that briefly describes the PeopleDepot project
• Add sections that address workshop prerequisites.
  • Identify which sections of the website guide should be added to PeopleDepot's guide.
  • Add troubleshooting section for GitHub SSH keys (for first time users or new machine).
  • Confer with Bonnie and new members to ensure additions to the guide are clear.
• Ensure all sections of the PeopleDepot contributing guides are updated and do not contain outdated information.

Resources/Instructions

• Current Contributing Guide old
• current contributing guide: https://github.com/hackforla/peopledepot/blob/main/CONTRIBUTING.md
• Website Contributing Guide
• Workshop Google Doc (WIP)

[AzaniaBG]

screenshots for contributing guide:

[ExperimentsInHonesty]

We need documentation for making tables that is super easy to follow for any new person joining the team. We may later want to do this as a workshop, but moving this issue to wiki documentation for now.

[ExperimentsInHonesty]

Since this issue was originally written, the contibuting.md content has been moved to our mkdocks https://hackforla.github.io/peopledepot/contributing/dev_environment/. There still is no SSH key setup/troubleshooting info on it. We are adding that to another issue so we can close this issue. #378 (comment)