READme

How to Access Code

First Open Git Bash

• Type in

  • eval "$(ssh-agent -s)" && ssh-add ~/.ssh/[name]_key

• CD Into your Repo
  • Open File Explorer
  • Open Folder you are trying to Access
  • Right Click Top Bar with Folders you are In
  • Copy Address
  • type: cd [paste address here]
• Open VS Code and Enter Repo

Branch Organization

main Branch:

• Use for Competitions
• Only Receives Pushes from Dev
• Do NOT Make Branches off of main

dev Branch:

• Use for Full Systems Tests
• Only Push to Main after Tested and Clean
  • No hardcoded values
  • Explanatory Comments
  • Code is Fully Functioning
• Make Feature Branches off of this Branch

feat-[name]:

• Used for new Features on the Robot
• Branch Name is all Lowercase
• Make Feature Branches off of the Dev Branch
• Use for Code changes
  • Changes can be as small or big as necessary
  • Only Contains what the Branch is named
    • EX. No climber code in a feat-shooter branch
• Push to Dev when code is Tested and Clean
  • No hardcoded values
  • Explanatory Comments
  • Code is Fully Functioning

bugfix-[name]:

• Used for a bugfix of a feature from Dev
• Branch Name is all Lowercase
• Make BugFix Branches off of the Dev Branch

chore-[name]:

• Used for cleaning code
• Branch Name is all Lowercase
• Make Chore Branches off of the Dev Branch
• Mainly used by mentor or lead

Useful Git Bash Commands

• git add .
  • stages all code to prepare for commit and push
• git commit -m "[Insert Message Here]"
  • Saves code locally with a msg of what was done to the code
• git push
  • Pushes Code to the Cloud
• git fetch
  • tells laptop their are new changes
• git pull
  • puts new changes on laptop
  • git pull does git fetch
• git pull origin Dev
  • pulls changes from Dev
• git checkout [branch name]
  • Changes your branch
• git checkout -b [branchname]
  • Creates new branch off of current branch
• git branch
  • Shows all branches that have been pulled on laptop
• git branch --all
  • Shows all branches since last fetch