Programming Assignment Submission Format Guidelines
All CS2704 Assignments must be submitted
to the EAGS. Please read
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
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.
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 in MS Word (.doc) or Adobe Acrobat (.pdf) format.
source files (.cpp and .h) See Code Quality.
Each .cpp and .h file must begin with a header comment block containing
name and e-mail address of programmer
date of last modification of file
MS Visual C++ project files (.dsp and .dsw) or Unix makefile, as appropriate.
(VC++ users: Do not submit unnecessary files, such as .ncb, .opt, .ilk,
.obj, .pch, or .pdb files.)
one sample set of input/output files
ASCII README.TXT file containing
Your name and e-mail address
The section of the course you're enrolled in (example : MWF 11:00-11:50)
Your instructor's name
The project name
The platform and compiler you're using (example : MSVC++6.0 under NT)
Any special execution instructions. (If your program is not fully functional,
be sure to mention that here and follow the directions in Partial
ASCII PLEDGE.TXT file containing
the an Honor Code Pledge. Each of your submissions must be pledged to conform
to the Honor Code requirements for this course. Specifically, you must
include this text file in your submitted archive.
On my honor:
- I have not discussed
the C++ language code
in my program
with anyone other than my instructor
or the teaching
assistants assigned to this course.
- I have not used C++
language code obtained from
or any other unauthorized source,
- If any C++ language
code or documentation used
in my program
was obtained from another source,
such as a text
book or course notes, that has been
with a proper citation in the comments
of my program.
Any design documentation required will be mentioned specifically in
the particular assignment. Be sure to check the Assignments
web page and read the FAQ.
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.
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
// CALLED BY: (LIST OF METHODS)
// CALLS: (LIST OF
// AUTHOR: name of author
// REVISIONS: DATE, REASON
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 Mike Parks