cs445 - Fall 2017 Project Deliverables

1. Source Code

This is simple and straightforward, we need your code such that we can build your project, deploy and then test it.

Attach your code to the project submission on the Blackboard.

Also, we want to see your code repo and we shold be able to check your code out and build that way, please make sure (i) you include repo information in the README file (see below) and (ii) we have access to your repository.

2. README file

The README file is mandatory. Here's what we expect to see in your file:

  • Configuration instructions
  • Build and deploy instructions
  • Copyright and licensing instructions
  • Known bugs
  • Credits and acknowledgements

3. Required Memo

You are required to submit a memo to your instructor that is flawlessly written. No spelling errors. No grammatical errors, etc. If the document is deemed unprofessional, then you don't get paid, er you don't get full credit for your work.

Your memo should state clearly the status of the project. Is it done or not? Does it meet all of the requirements? If anything is missing then state clearly what is missing from your work.

Failure to give a status for the assignment will result in a bad score for the assignment. Providing a status that's false or significantly misleading will also result in a bad grade for the entire assignment.

The other things that you should include in the memo are:

  • A link to your code repo.
  • Lines of code; do not include comments and white spaces; also, do not include here the unit tests.
  • Lines of code in unit tests; do not include comments and white spaces.
  • Unit test coverage as measured by the tool of choice in your chosen programming language.
  • Cyclomatic complexity for your code. Please don't submit code with cyclomatic complexity higher than 20 because you're just wasting your time.
  • The number of hours you needed to get the code working.
  • The number of hours you spent preparing your submission.
  • A list of challenges you faced while working on this assignment and the solutions you found to those challenges.

Not required, however very nice to have, is a list of recommendations for how to make the assignment better, to the possible benefit of future generations.

4. Assignment Submission

Make sure you name your submission according to the guidelines in the syllabus. Submit on the Blackboard before midnight on the day the project is due.

Last update: Aug 21, 2017 Virgil Bistriceanu cs445 Computer Science

$Id: project-deliverables.html,v 1.1 2017/08/21 23:17:13 virgil Exp $