Create a Guide/Template: Making a good CONTRIBUTING doc for your project's github repo

[ExperimentsInHonesty]

Overview

We need to create a guide to making a CONTRIBUTING.md file for a HackforLA projects so that new engineers on projects can get started easily no matter their skill level.

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

Update tracker issue (TBD) with the name of item you are working

GitHub's guidance for contributing files
100Automations guide for CONTRIBUTING files
Hack for LA website team's CONTRIBUTING.md file
311-data's contributing.md file
100 Automation's CONTRIBUTING.md
CivicTechJobs's CONTRIBUTING.md
Lucky Parking CONTRIBUTING.MD
VRMS README.md: not a contributing file but has information like that on a contributing file
TDM Calculator Contributing Code
Food Oasis Contributing Code

Projects with no contributing information or file:
Expunge-Assist
Access the data

Projects to Check

Tasks

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

[ExperimentsInHonesty]

@d-perez-8
Please provide update

1. Progress: "What is the current status of your project? What have you completed and what is left to do?"
2. Blockers: "Difficulties or errors encountered."
3. Availability: "How much time will you have this week to work on this issue?"
4. ETA: "When do you expect this issue to be completed?"
5. Pictures or links* (if necessary): "Add any pictures or links that will help illustrate what you are working on."

• remember to add links to the top of the issue if they are going to be needed again.

[JesseTheCleric]

Prior version of issue

Overview

We need to create a guide to making a CONTRIBUTING.md file for a HackforLA projects so that new engineers on projects can get started easily no matter their skill level.

Action Items

• Gather examples of how other projects have done it, 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 Engineering google drive
  • 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 tracker issue (TBD) with the name of item you are working

GitHub's guidance for contributing files
100Automations guide for CONTRIBUTING files
Hack for LA website team's CONTRIBUTING.md file
311-data's contributing.md file
100 Automation's CONTRIBUTING.md
CivicTechJobs's CONTRIBUTING.md
Lucky Parking CONTRIBUTING.MD
VRMS README.md: not a contributing file but has information like that on a contributing file
TDM Calculator Contributing Code
Food Oasis Contributing Code

Projects with no contributing information or file:
Expunge-Assist
Access the data

[JesseTheCleric]

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