FRC 2022

Team 5468's 2022 FRC robot code. This code is written in Java and is based off of WPILib's Java control system and utilizes a command based system.

The code is divided into several packages, each responsible for a different aspect of the robot function. This README explains setup instructions, the function of each package, and some of the variable naming conventions used. Additional information about each specific class can be found in that class' Java file.

Setup Instructions

General

1. Clone this repository
2. Run ./gradlew to download gradle and needed FRC/Vendor libraries
3. Run ./gradlew tasks to see available options
4. Enjoy!

Visual Studio Code (Official IDE)

1. Get the WPILib extension for easiest use from the VSCode Marketplace - Requires Java 11 or greater
2. In .vscode/settings.json, set the User Setting, java.home, to the correct directory pointing to your JDK 11 directory

IntelliJ

1. Run ./gradlew idea
2. Open the FRC-2022-Public.ipr file with IntelliJ

Eclipse

1. Run ./gradlew eclipse
2. Open Eclipse and go to File > Open Projects from File System...
3. Set the import source to the FRC-2022-Public folder then click finish

Basic Gradle Commands

• Run ./gradlew deploy to deploy to the robot in Terminal (*nix) or Powershell (Windows)
• Run ./gradlew build to build the code. Use the --info flag for more details
• Run ./gradlew test to run all of the JUnit tests

Conventions

Variable Naming Conventions

• CONSTANT_VARIABLE - Constant variables are all caps with underscores seperating names.
• normalVariable - Most everything else uses cammelCase.
• ClassName - All classes use Title Case per normal java convention.

Branch Naming Conventions

• a_branch_name - Generic branches. Mainly feature branches
• clean_##### or clean_NAME - A branch for cleaning up code
• dev_##### or dev_NAME - A branch for rapid development (Ex. At comps)
• fix_##### or fix_NAME - A branch for making thoughout fixes
• hotfix_##### or hotfix_NAME - A branch for hotfixes
• ##### - Number in the format MonthDayIncrement (Ex. for the second cleanup branch on Jan 20 (clean_01202))

*Using a modified version Google's Java Format. For exact linting rules goto .github/linters/linter.xml