Code Reviews

Code Reviews

Before merging a feature branch into dev, another code team member must do a code review on the pull request.

To do a code review, look through all the code changes. Several things to check for are:

• Does the code compile? (Make sure it compiles before requesting a code review)
• Are there comments? If no comments are present, reject the pull request.
• Is everything properly coded? Is the person using WPILib correctly?
• Are variable names correctly formatted?
• Do the changes match what the pull request says was changed? Avoid irrelevant changes on feature branches.
• Does the code maintain proper style and readability? Is it good code overall? This includes things like proper indentation, avoiding massive methods, using constants when possible, etc.

If all the above standards are met, accept the pull request. Otherwise, leave a note as to what needs to be changed and then reject the pull request.