Introduction to Computer Science: The Way of the Program — Mini-Project

Due Friday, December 15 by 11:59pm

Mini-Project Requirements

• Your code should include some comments briefly describing the purpose of your functions or class definitions, including the parameters they take. However, avoid overcommenting. There is no hard and fast rule, but in general, for each of your functions or class definitions, you should include a short one- or two-line comment summarizing what it does (not how it works). Include more detailed comments only if they are necessary to explain aspects of the code that are not obvious from reading the code itself. Also, choosing good, descriptive variable names can greatly reduce the need for comments.

• In addition to your code, you should submit a short writeup (maximum of 3-4 pages) in PDF format explaining the background and overall goals of your mini-project, your project results, and a brief summary of your program's features and general structure. Your writeup should be grammatically correct and well-written, and should include clear, detailed instructions on how to run your program. If your program contains bugs or other problems or shortcomings that you know about, you should briefly mention them here.

• You must submit all of your project files electronically, including:

  • Your project writeup in PDF format
  • All Python source code files
  • All supporting files necessary to run your program (image files, text files, etc.)
  • Anything else necessary to run your code

  Please be sure to include your name in a comment at the top of each program file.

• If you have questions about anything, just ask!