Assignment Submission Requirements

In addition to the requirements described here, make sure you comply with the policies on assignments and academic integrity on the course information page.

Submission

You must submit your work on-line via the Course Management System (CMS):

• Submit your work in advance of the deadline. Refer to the Late Policy.
• Never e-mail files to the course staff.

If you are not working with a partner:

• Click on the submit button to upload (submit) the file(s).
• For each requested file, click Browse... to locate your file. It does not matter if your filename differs from the requested filename.
• Click upload.

If you work with a partner, you must coordinate with your partner well in advance of the due date and time! Unless we carry over partnerships from a previous assignment, you have to invite each other on CMS, as follows:

• Click the groups button to register your group before submitting files.
• Enter your partner's NetID.
• Click Invite.
• Now your partner must login to CMS and accept your invitation.
• Either partner can submit the files as described in the instructions for a single person above.

You can find detailed instructions by clicking Help in CMS.

Format Requirements

File Size

• Each requested file has a size limit that is much bigger than a typical, correct file.
• If CMS reports that your file is too big, the usual reason is that you submitted a file in an incorrect format.
• Once CMS accepts an uploaded file, it will display the time of upload and the size of the uploaded file. The file size is one way for you to check that you submitted the file that you intended to submit.

What Files to Include:

• Include all files that we indicate on the assignment.
• If we do not indicate specific files, you must include all programs and solution write-ups. So, you must include every file with a .java extension along with other work we might have assigned.
• All files must have an extension that relates to its contents. For example, Java=.java; MATLAB=.m; Text=.txt; PDF=.pdf; Zip=.zip.
• For Java programs, do not include package declarations such as package cs1;.
• Do not include extraneous files: .class files, files that your IDE produces, or any other file that does not pertain to the assignment. You may include a readme.txt file, as explained below.
• You may include a brief readme.txt if there are special features or issues about your code that you need to communicate to the grading staff.
• Filenames: Unless specified, write each Java class in a separate file. The name of the class must match the name of the file. If you are instructed to write multiple classes in the same file, only one class can be public (usually the Main Class, the class that contains main).
• When instructed to zip files together, you must use a format that WinZip will understand on Windows XP.

Compilers and IDES:

• You must submit code that compiles, even if you have trouble getting it to run properly. We will be recompiling all of your code and running it. You must test your code at the command line with the JDK on Windows XP (see any public CIT lab) to ensure that your program works.
• Although we occasionally advocate certain IDEs, like DrJava and Eclipse, your code must always be able to run at the command line with the required version of Java. Refer to Course Info's "Java Help & Software" link for information about the required version of Java and how to use the command line.
• Why? Various IDEs occasionally exhibit different behaviors, and yes, sometimes have bugs. Generally, you shouldn't have to worry. But once in awhile something does pop up. We repeat: check your code at the command line!

Commenting/Style/Discussion

• Style counts! Follow the good style conventions for code elements, layout, and commenting. For advice on Java style, investigate these resources:
  • David Gries; alternative versions: [1] [2]
  • Sun's Coding Convention
  • an informed opinion (and links to others)
  • another informed opinion
• Do not include extraneous text in your programs, like debugging statements and superfluous comments. Also, if you answer discussion questions inside a program, you must comment out the text, because we are running all of your code.
• Do not use "fancy" formatting in discussion questions. Use ASCII text format (see this link to learn about writing resumes, too).  If you absolutely must format your discussion answers, print your work to PostScript or PDF.
• Place a comment block at the top of each file that you have created. The block must give the assignment number, due date, and the name(s), NetID(s), and CUID(s) of the creator(s).  For example,
  
  

  /**********************************  * Assignment 0: Example format  * Date: 1/1/1111  *  * Tad Morose: tm0, 123456  * Slough Feg: sl0, 654321  **********************************/