Create a Guide/Template: Readme for your project

[erigilg]

Overview

We need to create a guide to making the Readme file of every project. This file should have the information people may need before they start contributing to the project. Typically for a software project that would be an overview, goals, development process, technology, etc.

Action Items

The phases in the guide-making process are listed below. Each phase displayed in blue is linked to a wiki page with instructions on how to complete that phase. Open the wiki page in a new tab, copy the instructions for each part into the section labeled 'Tasks' at the bottom of this issue, and complete each task listed.

• Gather Examples Solo (open in a new tab)
• Gather Examples Collaboratively
• Create a Guide Draft
  • If needed, create a template
• Have your guide peer reviewed
• Present your guide for leadership review

Resources/Instructions

• Google Drive Folder for this Guide’s documents and shortcuts (to documents in other locations) 0076 [DRAFT] Readme for your project
• Guide Draft Guide: Readme DRAFT
  
• A curated list of awesome READMEs from non HfLA repos

Projects that have been checked

• 100 Automations
  • readme
• BallotNav
  • Readme for BallotNav
• Expunge-Assist (formerly known as Record Clearance)
  • Readme for Expunge Assist
• Food Oasis
  • Readme for Food Oasis
• Lucky Parking
  • Readme for Lucky Parking

Projects that have not been checked

• 311 Data
• Access the Data
• Brigade Organizer's Playbook
• Civic Tech Index
• Civic Tech Jobs
• Civic Tech Structure
• Data Science Projects
• Design Systems
• Engage
• GreenEarthOS
• Guides
• HomeUniteUs
• Internship project
• Open Community Survey
• TDM Calculator
• VRMS
• Hack for LA's Website
• Youth Justice Nav

Inactive or completed projects (do not use for examples)

Readme for Civic Opportunity Project
Readme for Railstats LA

Tasks

• This is where you will copy instructions from the wiki page for the step you are currently on.

[Olivia-Chiong]

hi @Rabia2219 Please update the following

• Progress: How much progress have you made on the issue? (looked at other examples and added URLS)
• Blocks: Are you facing any blockers?(yes)
• Availability: How much time do you have to work on it this week?(5 hrs)
• ETA: When do you think it will be completed?(by Tuesday 25th)

[Rabia2219]

Hi @Olivia-Chiong
Do we have something like this for Readmes?
(hackforla/product-management#3)
(https://docs.google.com/spreadsheets/d/1OJOKJDhUzzMzaFwmbGoOdh5Ohh53LCwS4u7LulVvBsQ/edit#gid=0)
I did try searching in Issues but was unable to find anything.
Thank you.

[Rabia2219]

@Olivia-Chiong
Hi Olivia,
Sorry I'm not able to make the meeting today. I've updated the Readme Guide as per our discussion. It is ready for another review. As per our discussion:

• the header logo has been fixed
• screenshots have been fixed
• all headings are in a question form
• links to Readme examples have been added
  Please let me know if you want to review it together or you can look over it and okay it for 'Leadership Approval'
  Thank you.

[ExperimentsInHonesty]

@Rabia2219 It looks like this issue is not yet complete. Here are my suggestions for improvement

1. finish finding all the README.md's for the projects
2. identify types of information contained and provide examples
3. meet with the project teams to find out what they think the purpose of the README on their repo is.

[fchan218]

Prior version of issue

Overview

We need to create a guide to making the Readme file of every project. This file should have the information people may need before they start contributing to the project. Typically for a software project that would be an overview, goals, development process, technology, etc.

Action Items

• Gather examples of how other projects have done, adding each example as a link in the resources section
  • Once done, remove the "TG: Gather Examples" label and add the "TG: Draft Template" label
• Create a draft template, either in markdown format in this issue or a google doc in the old product management google drive new product management google drive>Product Management Guides
  • Once done, remove the "TG: Draft Template" label and add the "TG: Create Guide" label
• Create a guide on how to use the template
  • Once done, remove the "TG: Create Guide" label and add the "TG: Review Guide" label
• Review the guide with product management communities of practice
  • Once done, remove the "TG: Review Guide" label and add the "TG: Leadership Review" label
• Present to Hack for LA leadership team for sign off
  • Once approved, remove the "TG: Leadership Review" label and add the "TG: Place Guide" label
• Possibly create an issue template on .github
  • Include link to template under resources if you add it as a template in .github

Resources

Update issue #104 with the name of item you are working
Guide README draft
Template (https://github.com/hackforla/.github/blob/f8f282d8ba0a658abf85b46ef1e31ad1aa26c871/README.md)
A curated list of awesome READMEs from non HfLA repos

Projects that have been checked

• 100 Automations
  • readme
• BallotNav
  • Readme for BallotNav
• Expunge-Assist (formerly known as Record Clearance)
  • Readme for Expunge Assist
• Food Oasis
  • Readme for Food Oasis
• Lucky Parking
  • Readme for Lucky Parking

Projects that have not been checked

• 311 Data
• Access the Data
• Brigade Organizer's Playbook
• Civic Tech Index
• Civic Tech Jobs
• Civic Tech Structure
• Data Science Projects
• Design Systems
• Engage
• GreenEarthOS
• Guides
• HomeUniteUs
• Internship project
• Open Community Survey
• TDM Calculator
• VRMS
• Hack for LA's Website
• Youth Justice Nav

Inactive or completed projects (do not use for examples)

Readme for Civic Opportunity Project
Readme for Railstats LA

[fchan218]

Assignee, Labels, Project Board Placement, and Milestones for this issue in the Product Repo:

[fchan218]

Files in this issue:

• Guide README draft
  • This file will need to be moved to the knowledgebase-content Google Drive
  • Unable to move this document to the knowledgebase-content Google Drive

[fchan218]

@Rabia2219 This guide issue is moving to the knowledgebase-content repo. If you would like to maintain edit access to the issue and its associated files, please fill out the Google Drive Access Form.