Commit Policy

TODO

At Competitions

1. Unless periodic connection to GitHub are available, only one computer should be used to modify robot software at an event to prevent conflicts

2. Prior to making any changes at an event, a Git branch must be created in the appropriate repository with the name of the event

3. All commit during the competition must be made in the new branch

4. All commit messages during the competition must start with the event name

5. Every version of the source code that is deployed to the robot in a match that has been modified since the last commit must be committed to the branch, unless there are no changes between two matches.

6. All commits of versions of the source code that is deployed to the robot in a match must also contain the match type and match number for identification.

7. All commits must have explicit and unambiguous documentation on the problem that it attempted to solve. It must be described foremost in commit messages

8. The above documentation also needs to be recorded elsewhere when 1) The problems are resolved over multiple commits, and 2)The problems concerns itself with a domain that is not limited only to the robot’s software, such as cables connected to wrong port, cables connected backwards, encoder not plugged in, solenoid not plugged in, pneumatics leaking, limit switch not fixed in place, limit switch had extra data cable, CAN bus giving timeouts, broken cables

9. If and only if a reset is necessary (the robot is nonfunctional with the current software and is retested to work with previous versions), then a new branch should be created from that point to retain both changes.

10. After the competition ends, a pull request must be created from every branch created that contains code changed at the competition

11. All pull requests must be reviewed by all programmers and relevant department heads before it is merged into the master branch.

12. A summary of changes, resolved issues, and new issues must be made to be archived