Checklist for exercises

Hans Petter Langtangen (hpl at ifi.uio.no)

Students will in groups of three (or two) perform peer review, i.e., assess other students' exercises. The review is written to a file called FEEDBACK.txt, located in the student's exercise directory. Below is a checklist of points to consider when writing a review.

For a program:

1. Are the files easy to locate? That is, does the directory has a logical name? Are individual files given names according to the exercise?
2. Is the program easy to read? More specifically,
   1. Are variables given self-explanatory names or names in accordance of the mathematical description?
   2. Are enough comments in the code?
   3. Is the code well formatted (use of whitespace etc.)?
   4. Is the code well organized in terms of functions or classes? (Also consider overuse of functions and classes in simpler problems!)
3. Does the program answer the various points in the exercise?
4. Does the program work?
5. Are there any (automatic) verifications of the code?
6. Are you able to run the code?

For a report:

1. Is the report easy to locate?
2. Is the report well formatted (title, author, sections, paragraphs, right spacings, low amount of typos, nice layout, introduction, conclusions, etc.)?
3. Is the text logic and easy to follow? Is there sufficient explanation of what is done?
4. Are the results correct?
5. Are there any verifications of the results?