Homework Submission Requirements 810:888 Agile Software Development

Introduction

This document outlines the rules you should follow when submitting a projects and homework for grading. Any of these rules can be overridden by a particular assignment but, if the assignment doesn't say otherwise, follow each of them.

Forms of Submission

When you are asked to submit a set of files, you must submit them in two forms: electronically and hard copy.

• electronically:

  • Log in to the 810:188's electronic submission system using your CNS username and password.

  • Select the desired assignment.

  • Follow the instructions given to upload the required files and, if allowed for that assignment, any optional files.

• hard copy:

  • Print a hard copy of each file.

    Your print-out should fit on standard 8-1/2"x11" paper printed upright, with no line wrap.

    If you would like to save paper, you may print your files "2-up".

  • Assemble them in the order specified by the assignment.

    Yes, the order of the files matters.

  • Staple them.

    Paper clips, folded corners, and nothing at all are not acceptable.

  • Bring the hardcopy to your next class period.

    Electronic submissions will generally be due early on the morning of a class day. Unless told otherwise, you must submit your hardcopy at the beginning of our next class meeting.

Types of File

... more on source files and test/demonstration files later

Documentation

Document each source file with a header block that includes the file's name, your name, the name of the file's original creator (if not you), and a modification history that lists the date of each change to the file and the change made.

Here's an example:

    //
    // FILE:     factorial-aps.java
    // AUTHOR:   Eugene Wallingford
    // DATE:     01/31/99
    // COMMENT:  Using accumulator passing style.
    //
    // MODIFIED: 03/08/99 by Eugene Wallingford
    // CHANGE:   Fixed base case to handle negative arguments
    //

Your block need not look exactly like this, but it should contain the same information.

Style

I do not require you to follow a lot of specific style rules, but I do ask you to follow several basic guidelines to improve the readability of your code.

1. Indent consistently. Indent all statement bodies the same number of characters. Be consistent within a single file and across multiple files. Adopt some conventions that you like, and stick with them.

2. Use names that say what they name. For example, num-scores is a better name than n, and number-of-scores is better yet. By convention, we use single-letter variable names in only one context: as (loop) index variables.