PR Guidelines

General requirements for PRs

In general, PRs should contain the following (where applicable for your particular project):

Review process

Asking someone to review your code is helpful for the code author and the reviewer, but it is also time consuming. Therefore, please resepect the time of the reviewer by checking over all of the guidelines here before requesting a review. If you are a reviewing someone’s code, please make a full-fledged effort to provide constructive feedback. After another student has reviewed your code, and you have addressed all of their comments, you can request a review from the TAs.

Form for peer code review

Form to request TA code review

Checklist before requesting a review

PR itself