Programming naming conventions - VTAstrobotics/Documentation GitHub Wiki

Objective: To describe naming conventions.

Remember that everyone owns this documentation and if you find any errors or out of date information you should fix it.

Contents

Prerequisites

To understand the content on this page, you should know how to

  • make git branches
  • Read

GIT

When naming git branches, you should follow a couple of standards when making a new branch you should ideally be trying to add one feature name your branch something like

features/<thingy> features/<arm_current_sensing>

if your branch is trying to capture something like a certain milestone in the robot program name it something like

comp_code

demo_code_for_stem_day

When fixing a bug already committed you should create a bug/ branch

bug/current_over_10M

bug/only_goes_forward

Notes:

use _ for spaces

use all lowercase

if you need to put a date use

mm-dd-yy

⚠️ **GitHub.com Fallback** ⚠️