Git etiquette - UPenn-RoboCup/UPennalizers GitHub Wiki

Every team member should strictly follow the rules for git.

• Branch management:

  • There is a "master" branch for every period of UPennalizers development. The name follows Robocup20xx for overall development, USOpen20xx for branch used during U.S.Open competition, Germany2016 for competition branch during Robocup World Competition. In addition, we occasionally have VisionDev20xx for vision-related developments, MotionDev20xx for locomotion-related developments. Other branches that individuals created will be deleted after finish. Lastly, we use demo for demos in the lab.
  • Official branches are expected NOT to contain any broken code, we will inspect using git commit log.

• Mandatory rules:

  • Check branch and pull on robot / personal computer before starting to work.
  • Commit changes at least on a daily basis
  • Test related processes to make sure everything is working BEFORE committing your changes. NO broken code should be committed on git.
  • All commits must include (e.g. rachel dcm.lua fixed merge conflict, added detailed comments)
  • Make sure to include your name in any commits, and never have uncommitted, local changes on a robot. (save files to your local machines as backup if you also don't want to commit the files / changes)