Reviewing Code Instructions

Read to the end! There are submission notes there!

Easiest way:

Download, edit, upload

If you are working on your own code, download the repository, or work with the file as it is named in the repository. (This is important!)

If you are working on someone else's code, download the repository, and work with the file as it is named in the repository. Upload that file, unedited, into the corresponding repository. If it shares the same name as file in YOUR repository, rename it by adding "-review" before the .py extension.

Once you have the file downloaded, edit it as required by the assignment. Your review summary (criticism sandwich) goes in a multiline comment (triple quotes) at the bottom of the script.

Criticism sandwich review summary goes at the end of a script in a multiline comment.

When all of your edits are complete, upload the file to the corresponding repository. It should have the same name as its original file.

If it's your file, it goes into your repository, with the same name as the original file.

If it's a classmate's file, it goes into your repository, with the same name as the unedited version!

Viewing changes (and instructor feedback) in Github

You can check to see how your code review looks by using the Pull Requests tool, which allows developers to submit suggestions and requests to the repository owner.

Navigate to the repository of choice. Then select "Pull Requests" from the tabs along the top:

Repository, with Pull Requests tab highlighted with a magenta box

Then select Feedback from the menu:

Feedback button highlighted with a magenta box

Finally, select Files Changed. (The number of changed files will be shown next to it. This number will vary based on how many uploads you have made.)

Select the reviewed file from the left hand menu to see changes. If looking for comments from the instructor, select the file you uploaded for the assignment. If checking your review, select the file you uploaded for the code review.

Select the file to examine from the left hand menu.

The changes from the last upload (commit) is shown in red and green highlights. Red highlights indicate deletion (a line of code was deleted since its last upload), and green highlights indicate an addition. If you upload subsequent times, it will only show the changes between the last 2 uploads (commits). You must upload the same file name, or this version history will not work!

This is what updated code looks like under "files changed" tab. Added lines of code are shown highlighted in green. Deleted lines of code are shown highlighted in red.

Comments (from the instructor) are shown in this interface as well.

Comments from Dr. Z will look like this

Once you upload the same file name twice: one original or unedited, and one edited, your review has been submitted. You MUST submit a link on Canvas to the repository with the reviewed code to receive full credit. (It is very hard for me to sift through everyone's repositories!)