CS 2704 Programming Assignment Submission Format Guidelines - Spring 2000


All CS2704 Assignments must be submitted to the EAGS. Please read the guide.

Submit assignments to:  http://spasm.cs.vt.edu:8080/curator/

Submission Guidelines:



Archive Format

The CS2704 programming assignments must be submitted to the EAGS in a compressed zip archive format. Students who are unfamiliar with working with zip archives are encouraged to work through the CS1205 compression tutorial. Unix users will submit a standard gzip'd tar file.

Shareware utilities for creating and managing zip archives on Windows are readily available:

Please generate your archive such that it uses maximal compression. Do not employ protection or encryption on the archive or any files it contains.

Archive Contents

The deliverables that the submitted archive file must contain will be listed in each project specification. Generally, this will  include (but is not limited to) the following:


Design Documentation

Any design documentation required will be mentioned specifically in the particular assignment. Be sure to check the Assignments web page and read the FAQ.


Demonstrations

Some programming assignments may require you to demonstrate your program to one of the CS2704 TAs during a scheduled demo time. In the case of  a nonfunctional program, the TAs may also require you to demonstrate your program during their office hours in the McB 116/118,124 lab in order to recieve Partial Credit.


Code Quality

Students are expected to follow the Departmental guidelines documented in the "Elements of Programming of Programming Style". Code must be WELL-DOCUMENTED, appropriately indented and VERY READABLE. Points will be deducted for poorly presented code. Each compilation module should contain only related procedures. Each method header should look similar to the following template:
 

//
// METHOD NAME
//
// DESCRIPTION OF METHOD (1-2 SENTENCES)
//
// PARAMETERS: NAME AND ROLE IN ALGORITHM OF EACH
//
// CALLED BY: (LIST OF METHODS)
// CALLS:     (LIST OF METHODS)
//
// AUTHOR: name of author
//
// REVISIONS: DATE, REASON
// 


Partial Credit

To receive partial credit for programs that are non-working, or are not fully functional, a brief one or two paragraph description of the problem(s) must be included in the assignment archive in a text file named "PARTIALx.TXT"), where 'x' is replaced by the number of the project. The location, routine minimum, of each suspected problem/error must be specified along with possible corrections that need to be made.



Please send comments and suggestions to David Tessendorf at dtessend@vt.edu.