Repository navigation
Create a Guide/Template: Readme for your project #76
Description
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
- BallotNav
- Expunge-Assist (formerly known as Record Clearance)
- Food Oasis
- 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.
Activity
Olivia-Chiong commentedon May 19, 2021
Rabia2219 commentedon May 22, 2021
Rabia2219 commentedon Jun 23, 2021
ExperimentsInHonesty commentedon Apr 1, 2022
fchan218 commentedon Oct 16, 2024
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
old product management google drivenew product management google drive>Product Management GuidesResources
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
Projects that have not been checked
Inactive or completed projects (do not use for examples)
Readme for Civic Opportunity Project
Readme for Railstats LA
fchan218 commentedon Oct 16, 2024
Assignee, Labels, Project Board Placement, and Milestones for this issue in the Product Repo:
fchan218 commentedon Oct 16, 2024
Files in this issue:
fchan218 commentedon Oct 16, 2024
@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.
11 remaining items