Homework Style Guidelines

All programs submitted as homework should satisfy certain style guidelines. You will lose partial or full credits, if you did not follow these steps:


  1. For each part of the lab assignment there are detailed descriptions of what you should turn in. In almost all cases, you should submit a SINGLE gzipped tarball.  In the tarball, you should include ALL supporting files (source files, data files, etc.) as attachments to the submission email (a single message).  Please send only UNIX-readable (text) files (that is, no MS Word documents!!!).  Word documents will be considered a gauntlet, personal affront to the professor and will result in ignominy and public ridicule.  All work will be graded on the LINUX CLUSTER (you may work on Solaris, hpux, Aix, SCO Unix, Irix, etc., BUT, you should ensure before delivery to the grader that your code, scripts, and all supporting materials do work in every way on the linux cluster, as that is where your work will be graded).
  2. FAILURE TO PROVIDE AND DELIVER TO THE GRADERS ALL SCRIPTS, ALL COMMANDS, AND ALL SUPPORTING FILES, TEXT OR SOURCE, YOU USED TO DELIVER AND PRODUCE THE SOLUTION WILL RESULT IN A LOSS OF POINTS.  IF THE GRADERS, WORKING SOLELY ON THE LINUX CLUSTER, CANNOT REPRODUCE YOUR SOLUTION OR ANY PART OF YOUR SOLUTION FROM THE SET OF INFORMATION YOU PROVIDE, YOU WILL LOSE PARTIAL OR FULL CREDIT.

  3. Each source file should start with a header consisting of the following information, in the following standard layout:
     
    For C code and result script files:

    /* filename; Name: submitter's name(s); Lab: e.g. 1,2, etc; Expected Date submitted: e.g. 01/07/02 */

    For shell script files:

    #
    # filename; Name:submitter's name(s)> Lab: <e.g. 1,2, etc> Expected Date submitted: <e.g. 01/07/02>
    #
  4. Comments should be added within source code where necessary to understand how the code works.


    Ross Girshick