Create a ReadMe

[SheIsBukki]

Dependency

#8

Overview

We need to have a working READme file to easily onboard new team members and compile relevant information for other teams and CoPs that will interact with us.

Action Items

• Review the readme file and identify what information is needed and applicable
• Review GreenEarthOS repo as a guide
• Review the project one sheet and other documentation to be used in creating content
• Update project one sheet One-Sheet for Guides Project #8
• Apply changes to ReadMe

Resources/Instructions

https://github.com/hackforla/guides/blob/main/README.md
Green Earth OS

[SheIsBukki]

On Reviewing the Current Guides ReadMe:

I think we don't need Installation Instructions, Working with forks and branches, Working with pull requests and reviews, and Testing. Licensing too maybe.
I don't know whether PM also have to work on Issues; bugs, features, in the same way engineering team does.

Using the GreenEarthOS ReadMe as a guide:

The GreenEarthOS readme applies better for the Guides readme. All we have to do is create a channel for Guides or share the link to the DM group. We also have to state our meeting time. I don't think we've created our Project Context for Guides, so we have to create that

[ExperimentsInHonesty]

Hack for LA Guides

The Guides project seeks to create guides out of the effective practices that we have created/iterated on projects in order to share replicable processes and practices so that we can continue to grow our peer learning and iterative culture, improving outcomes for the whole ecosystem.

[ExperimentsInHonesty]

Current draft
[our logo here] WIP

Hack for LA Guides

The Guides project seeks to create guides out of the effective practices that we have created/iterated on projects in order to share replicable processes and practices so that we can continue to grow our peer learning and iterative culture, improving outcomes for the whole ecosystem.

Project context

The Guides will cover templates, how-to’s, and straightforward instructions to teach members of each communities how to

Help us write our one sheet for the project by volunteering! [insert one sheet here]

Technology used

• GitHub project board
• Slack
• Google drive

How to contribute

• Join the HackforLA slack workspace
• Join the slack channel #guides and say hi! Tell us your skillset and how you're looking to contribute.
• One of our product managers will add you to the meeting invite & the project resources
• Join our team meetings (these are subject to change based on need, if you can't make these times but you want to be on teh team, let us know your availability on slack).
  • Monday & Wednesday 7:30-9:00 am (PDT) / 3:30-5:00 pm (WAT)
  • Friday 8:30-9:00 am (PDT) / 4:30-5 pm (WAT)