Commit Standards - TurtleTekFTC/FtcRobotController GitHub Wiki

Commits should always include the What and Why for each change:

What: What changed. Should be descriptive, but succinct.

Why: The reason for the change.

Some good examples:

  • Remove redundant code that does not add functionality
  • Refactor test.java for better readability
  • Fix recursive bug in the main loop to prevent stalling

Some bad examples:

  • Remove line 15 (Not descriptive enough)
  • Update test.java (Not descriptive enough)
  • Add new variables to the class (Missing the why?)