cse341 - Submission Guidelines

When you submit an assignment, please try to adhere to the following guidelines. Grading is already a lot of work, so please help out by presenting things to your TA in a manner that will make the paper shuffling easy. It will make your TA happy. And a happy TA is a high-grading TA.

Note that this list is not meant to be complete. It's the set of guidelines that I always wished I had to make submissions more consistent. I'll try to update the list when I come up with more stuff I'd like to see.

I'm sorry if this is a bit of a pain, but it really makes life easier for me. Thanks for sticking to these guidelines.

Name and Section Number

Put your name and section number on everything you submit. If stuff is stapled, it suffices to put your info on the front page. If you're working a groups, put both of your names and section numbers on the submission.

For electronic submissions, put your information at the top of every file. If your file is a program, put it in a comment. If you were in a group, put both of your names in the files.

Number of Copies

Please submit either an electronic copy or a paper copy of your assignment, not both. When you submit both, it gets confusing, especially when they're different.

If you're working in a group, submit only one copy for the group. If you're submitting electronically, submit under only one user. If your names are in every file (see above) then I'll know to assign the grade to the whole group.

Deadlines

Unless otherwise stated, assignments are due at the start of class or section on the due date. This is also true for electronic submission. The time you submitted is recorded with your submission when you use the turnin command.

Using turnin

turnin is the command available on the instructional UNIX machines for submitting things electronically. You can use it to turn in a single file, multiple files, or directories. Successive uses of turnin overwrite previous submissions, so you can fix things in your code (up until the due date, of course). For more information, consult the man page.

Testing output

The script command on the UNIX systems can be used to generate a transcript of a UNIX session that can then be edited for testing output. See the man page for more details.

When you submit testing output, please don't submit pages and pages of meaningless output. Submit only the parts of the testing output that show the interesting tests and their results. Your job is to convince me that your program works, not that you can produce lots of output with it.

Comments

Your code should contain at least one comment, the one at the top of the file that says your name(s) and section(s). I do not require you to fill your file with meaningless comments at the start of functions, etc. The file containing your program should be clear and understandable enough that someone not familiar with it (i.e. me) can read it and see that you know what you're doing. Comments are just one way to achieve this readability.