2023-2024 FRC Season

All of our code for the 2023-2024 FIRST® Robotics Competition CRESCENDO, Presented by HAAS and projects in the offseason.

This repository includes the following:

• The Training Folder^TM, which contains all the training projects our newest programmers coded and worked on to get familiar with our *amazing* workflow.
• Our Trunk or Treat Bot, Telepatata, which (shockingly) is our robot code for Trunk or Treat.
• Larry, our team's first working Swerve Drive.
• Larry, again, which is Larry re-written in the robotpy MagicBot framework.
• Other stuff later, probably ;)

Programming Convention

We use Trunk Based Development. Trunk Based Development makes it easier to have a team of people working together on one project. It works by seperating everyone's work into seperate branches that can be committed and pushed independently without having to update every change thats made in main.

As of 12/3/2023 we have 7 full-time programmers, which may not seem like a big deal, but it's literally more than double from how much we had last year. Because of this, we'll try and enforce Trunk Based more.

The Art of Not Pissing Off The Other Programmers, by Pickle_Face5

"Um... I don't even know where to start with you. I mean, do you even know who you're talkin' to?"

As a senior-ish programmer for this team, it's my job to make sure you guys don't annoy us too much.

This section's role is to teach you our workflow so nothing catches fire and burns us to death. Programming's only fun if nothing breaks, so we try to break stuff less often than normal. Aside from that, these are the 3 main ideas of Trunk Based programming that you need to follow. Please follow these.

Rule #1: Don't Commit or Push to The Main Branch. Please.

PLEASE PLEASE PLEASE don't do this. This ends up having everyone having to redo their branches to match the pushed code, which just slows us down. (and during build season, we NEED time)

Double check before commiting or pushing anything it's not going to main.

Rule #2: Name Your Branches Something Good and Keep Them _small.

When creating a feature branch (the branch that you write code on then later push everything to main), make sure you're being specific, clear, and concise what your branch will add. Being general and broad confuses other programmers and makes branches take longer to complete. (which we'll elaborate more on in Rule #3)

Example Branch Names (Featuring Palpatine)

Good Branch Name	Bad Branch Name	Why That Branch Name SucksTM
palpatine-guitar	palpatine-control	This branch name is too generic. What about control are we adding or changing to Palpatine?
palpatine-refactoring	refactoring	While this branch name tells us what it's doing, it doesn't tell us to whom it's comment refactoring to. Always include the name of the robot in your branch.
palpatine-exploding-glitch-fix	palpatine-bug-fix	This branch doesn't tell us what big fix it's fixing on Palpatine.
palpatine-controller-drift-fix	palpatine-controller-fix-because-it-drifts-slightly-to-the-right	"I ain't reading all that 🔥" - Me after seeing that branch name probably
palpatine-back-flip	code	...please don't do this.

Note

A basic branch should be something similar to <robot-name>-<what-your-doing>

Basically, when creating your branch, ask yourself the following:

• "Can I tell what robot this is for?"
• "Can I tell what I'm adding/fixing?"
• "Is this a stupid idea?"
• "Why the hell did I think I would enjoy this?"
• "chiken burgur

Important

NAME YOUR COMMITS WELL TOO, I'M TIRED OF SEEING "code" AND "fixed something" AND "forgot to push this last time" PLEASE NAME THEM WELL AND REMEMBER TO PUSH YOUR CODE 😭

Rule #3: Merge Branches ASAP

Sitting on a branch for a month will probably be uncomfortable and cause issues when merging your branch. This is why we enforce Rule 2; to give your branch a small amount of time to finish.

Because the branch has been worked on for a month, lots of changes have (hopefully) been done to the main branch, meaning your amazing branch is now completely outdated! 🥳

To avoid this, finish your current branch before working on a new one. DON'T MULTITASK.

Note

To keep branches from taking forever, give yourself a deadline; have your new features take ~1-2 weeks to finish, depending on the size of it.

TL;DR

1. Don't push code to main, create a branch and merge it instead.
2. Name your branches something easy to understand.
3. Get your crap done on time.
4. Please bring me a coke during build season, it would make my week.