This repository contains the codebase the 2025 FRC Reefscape season.
- Consistency: Adhere to established coding standards to ensure uniformity across the codebase.
- Readability: Write clear and understandable code to facilitate maintenance and collaboration.
- Documentation: Include comments where necessary to explain complex logic or decisions.
- Subsystems: Use
UpperCamelCase. For example,DriveSubsystem. - Commands: Use descriptive
UpperCamelCase. For example,RunArmWithJoystickorDriveToWaypoint. - Constants:
- In the constants file: Prefix with 'k' and use
UpperCamelCase. For example,kMaxSpeed. - Within other files: Use
UPPER_SNAKE_CASE. For example,MAX_SPEED.
- In the constants file: Prefix with 'k' and use
Following these conventions enhances code clarity and maintainability.
We utilize Spotless to maintain consistent code formatting. The build process automatically applies Spotless checks. Therefore, ensure you build the project successfully before committing to verify that all code adheres to the formatting standards.
Your PR will fail if not :(
- Branch Creation: Create a new branch for each feature or bug fix. Avoid committing directly to the
masterbranch. - Naming: Use clear names that convey the purpose of the branch, enabling team members to easily understand its focus. For example,
drivetrainorintake. - Committing Unfinished Work: It's acceptable to commit unfinished code to your own branches to allow others to continue your work if necessary. Ensure that such commits are well-documented in Slack, clearly indicating the current status and any remaining tasks.
By following this strategy, we maintain a clean and organized commit history and avoid confusion.
A customized VS Code workspace configuration is provided to streamline development:
- Workspace File: The
.code-workspacefile in the root directory includes specific settings, launch configurations, and extension recommendations tailored for this project. - Setup: To utilize this configuration, open the workspace file in VS Code by navigating to
File > Open Workspace...and selecting the.code-workspacefile. - Benefits: This setup ensures a consistent development environment across the team, with predefined settings and tools.