Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create a Guide/Template: Readme for your project #76

Open
7 tasks
Tracked by #136
erigilg opened this issue Mar 5, 2021 · 8 comments
Open
7 tasks
Tracked by #136

Create a Guide/Template: Readme for your project #76

erigilg opened this issue Mar 5, 2021 · 8 comments

Comments

@erigilg
Copy link

erigilg commented Mar 5, 2021

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.

Resources/Instructions

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

Tasks

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

This comment was marked as outdated.

@Rabia2219

This comment was marked as outdated.

@Rabia2219
Copy link
Member

Rabia2219 commented Jun 23, 2021

@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
Copy link
Member

@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
Copy link
Member

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

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
Copy link
Member

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

Screenshot 2024-10-16 at 5 33 03 PM

@fchan218
Copy link
Member

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
Copy link
Member

@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.

@fchan218 fchan218 transferred this issue from hackforla/product-management Oct 16, 2024
@fchan218 fchan218 added this to the 06.01 MVP Knowledge milestone Oct 16, 2024
@fchan218 fchan218 moved this from To be Checked on 04-18-2022 to Issues With Assignees in P: Guides: Tracker of issues in CoPs Oct 16, 2024
@fchan218 fchan218 moved this from Issues With Assignees to Needs to be Triaged in P: Guides: Tracker of issues in CoPs Oct 16, 2024
@fchan218 fchan218 moved this to Needs to be Triaged in P: Guides: Knowledgebase Content Tracker Oct 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: Needs to be Triaged
Status: Needs to be Triaged
Development

No branches or pull requests

6 participants