Assignment Submission Guidelines

Projects Policies

Click on one of the policies below for details.

Hardcopy Policy


Electronic Copy Policy

For your project you must submit a hardcopy and an electronic copy. Your electronic copy will be turned in using the turnin script on troi. If you do not have a troi account, you cannot turn in your project!

The following are some of the policies we have about your electronic copy. Please read this carefully, as failure to follow these guidelines could result in loss of points.


Readme Policy

Readmes are for the TA's benefit who is grading your project. So they can be useful to us, please follow the following strict guidelines. This makes it easier for us to understand your program, which makes us more likely to be more generous in giving you points.

Code Style Policy

Code style can really be thought of as 2 different categories. Organization refers to how well you break up your program into classes, etc. How well you program in an 'object oriented' fashion, etc. Documentation refers to how easily your code can be interpreted by another human being. It deals with things such as comments within your code, good variable naming strategies, general code readability (such as tabs, etc.)

While perhaps not obvious now, good code style is very important if you want to work on big projects or get a job with a company. Good code style allows your code to be reusable and legible for years to come. While that's not so important for a 171 project, if you work on a database system for a client, they will want to be able to go in and understand (and perhaps modify) your code in the future.

So, here are some guidelines for having good organization and documentation.

Code Organization

Code Documentation


Adapted from Nate Blaylock's (a graduate student) CSC 172 Submission Guidelines.