Project Final Checklist

Home - Syllabus - Schedule - Project

This is a list of tasks assigned to all groups:

• clean build (working on any combination of Ant, Eclipse, Windows, and Linux)
• customized IRC Client name, default nickname, and default username (see Lab1 Task 0)
• changeset 153 applied to your project (see Lab3 Task 1)
• at least 3 acceptance tests customized to your implementation, and passing. (see Lab4 task 1).
• all tests passing
  • NO tests that connect to a live server or instantiate a GUI may run automatically
  • You may have live-server and GUI tests, but they must not run automatically, and you must have mock versions of these tests that do run automatically.
• good test coverage
  • use EclEmma to look for areas to improve coverage (see Lab3 Task 0)
  • do your best to cover all the code you can, except where you have good reasons not to, as discussed in lecture
  • with the exception of IRCWindow and IRCConnection that are mocked, expect to have 80% or higher statement coverage.
  • there's no magic ideal number of tests, but definitely expect to have more than 100 (we have 37 just in the base project code + 6 in changeset 153)
• documentation:
  • there must be a doc directory containing all the documentation.
  • must have consistent, valid javadoc comments at least for all classes, methods, and public fields (member variables)
  • javadoc must generate the API without warnings.
  • clients with user interfaces must have good (built-in) help messages for all client commands (use case diagrams could also be used for this purpose)
  • bot-like clients must have adequate documentation explaining how to run, configure, and use the bot (use case diagrams could be used for this purpose)
  • use case diagram(s) for the 3 concordion acceptance tests that you produced
  • class diagram(s) representative of the project code (only class names and relationships names).
• working Ant build.xml as described in Lab3 Task 2, Lab4 Task 3, and with the following changes:
  • the doc target creates a directory called api inside doc.
  • the clean-doc target removes the api directory.