Skip to content

Code Reading Checklist

βœ… Code Reading Checklist

The Code Reading Framework is a set of five questions you can ask about any file in the robot project. By the end of this course, you should be able to answer all five questions for any file you open.

The Five Questions

  1. What does this file do?
  2. What subsystem or command does it belong to?
  3. What methods does it expose?
  4. What does it depend on?
  5. When does this code run?

File 1: IntakeSubsystem

Open IntakeSubsystem.java and answer the five questions.

πŸ” Code Reading: IntakeSubsystem.java
What does this file do?
What does this file do? _______________
What subsystem or command does it belong to?
What subsystem or command does it belong to? _______________
What methods does it expose?
What methods does it expose? _______________
What does it depend on?
What does it depend on? _______________
When does this code run?
When does this code run? _______________

File 2: AutoShootCommand

Open AutoShootCommand.java and answer the five questions.

πŸ” Code Reading: AutoShootCommand.java
What does this file do?
What does this file do? _______________
What subsystem or command does it belong to?
What subsystem or command does it belong to? _______________
What methods does it expose?
What methods does it expose? _______________
What does it depend on?
What does it depend on? _______________
When does this code run?
When does this code run? _______________

File 3: RobotContainer

Open RobotContainer.java and answer the five questions.

πŸ” Code Reading: RobotContainer.java
What does this file do?
What does this file do? _______________
What subsystem or command does it belong to?
What subsystem or command does it belong to? _______________
What methods does it expose?
What methods does it expose? _______________
What does it depend on?
What does it depend on? _______________
When does this code run?
When does this code run? _______________

Bonus: Pick Your Own File

Choose any file from the robot project that you haven’t analyzed yet and apply the framework.

πŸ” Code Reading: (your choice).java
What does this file do?
What does this file do? _______________
What subsystem or command does it belong to?
What subsystem or command does it belong to? _______________
What methods does it expose?
What methods does it expose? _______________
What does it depend on?
What does it depend on? _______________
When does this code run?
When does this code run? _______________