Create a Guide/Template: Setting up Git

[gregpawin]

Overview

We need to create a guide to version control, namely Git since it is a crucial Hack for LA technology, with just enough knowledge for beginning developers to start working on a project and be able to share their contributions.

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

Projects to check

• 100 Automations
  • Nothing in Wiki
  • README.md - had no references to Git workflow
  • CONTRIBUTING.md had some information
  • Issues
    • Issue re vs code setup Creating .vscode file for configuration 100Automations/Website#187
  • Nothing on slack channel.
  • No git related information in Project board
• 311 Data
  • CONTRIBUTING.md addresses github branching.
  • Nothing on Wiki
  • Nothing in Issues tab
  • Nothing found in Project board
  • No discussion about git workflow in slack channel.
• Access the Data
  • Nothing git related in Wiki
  • Nothing in project Issues tab
  • Project board link cards have nothing git related
  • Nothing in project's slack channel
• BallotNav
  • Nothing in Wiki
  • Nothing git related in Issues tab
  • Nothing in Project board card links
  • Nothing in Slack channel
• Brigade Organizer's Playbook
  • Nothing in Wiki
  • Nothing in Issues tab
  • Nothing related to version control in Project board
  • No slack channel
• Civic Tech Index
  • CONTRIBUTING.md addresses git workflow extensively
  • Issues
    • Update to CONTRIBUTING.md (Update CONTRIBUTING re git add one or some files, not all. #420
  • Nothing in project board link cards
  • Nothing git related in slack channel
• Civic Tech Jobs
  • Installation procedures found in CONTRIBUTING.md contains valuable resources that addresses git workflow
  • Nothing in project's Wiki
  • Nothing in Issues tab
  • Nothing in project board link cards
  • Nothing in slack channel
  • Nothing git related in README.md
• Civic Tech Structure
  • Nothing git related in README.md
  • Nothing in Issues tab
  • Nothing in Wiki
  • Nothing in Project board link cards
• Data Science Projects
  • Nothing git related in README.md
  • Nothing in Wiki
  • No Issues that are git related
  • Nothing in Project baord
  • Nothing git related in Slack channel
• Design Systems
  • Nothing in project's Wiki
  • No git related Issues
  • No git related card links in project board
  • Nothing in slack channel
• Engage
  • Nothing here
• Expunge-Assist (formerly known as Record Clearance)
  • Nothing in README
  • No git related Issues
  • Nothing in project's Wiki
  • Nothing in project board card links
  • Nothing in Slack channel
• Food Oasis
  • Developers section in the Getting Started page mentions about installing Git
  • Nothing in Project Board
  • Issues
    • Strategize Devops food-oasis#323
    • Add typescript to backend app food-oasis#1248
  • Nothing in Slack Channel
• GreenEarthOS
  • Nothing in Wiki
  • Nothing in Project Board
  • Nothing in issues
  • Nothing in Slack channel
• Guides
  • Nothing in wiki
  • Nothing in Project Board
  • Issues
    • Resources mention about this current issue Onboarding: Isaiah Ozadhe guides#97
• HomeUniteUs
  • Wiki mentions setting up Git as a requirement.
  • Nothing on Project Board
  • Nothing in issues
  • Nothing in Slack channel
• Internship project
  • Nothing in wiki
  • Nothing on Project board
  • Issues
    • Comments in issue mentions about blocker in setting up Git Agenda for Internship Stand Up internship#9
• Lucky Parking
  • The developer contributing Guide mentions about Git workflow
  • Nothing on Project Board
  • Issues
    • Issue mentions about git branching Setting up a dev and production environment lucky-parking#316
    • Issue mentions about cloning repo Move frontend code to EC2 instance on Hack4LA AWS server. lucky-parking#141
  • Nothing on Slack Channel
• Open Community Survey
• People Depot
• TDM Calculator
• VRMS
• Hack for LA's Website
• Youth Justice Nav