Elements to include with your project repository #

Note that these items do not include anything about documentation, which should also be included with coding projects.

[ ] 1. Project description #

• Description of the program such as a README file
• Project requirement(s) and tracking. Sample approaches listed below:
  • TODO file to track their task list
  • CHANGELOG file to track revisions,
  • Use issue tracker that comes with a github repo, respond to issues in your commit messages
  • Whatever else you think of that is relevant
• Instructions on how to run your program or code
• Description of technologies used

[ ] 2. Source code with comments #

• Comments describe why each class and function exist
• Comments describe any conditional or control flow logic

[ ] 3. Submit to the form before deadline #

• Link to your code (you can use any platform. GitHub is common)
• Repository is either public, or you’ve added me as a collaborator

“Writing documentation is like saving for retirement. It’s hard to tell if you have enough at the time you’re doing it. Only later can you tell if you have enough, and usually you wish you had more.” -J.Wirth

Elements of Style and Presentation #

• Clean Code
• Indentation throughout code is uniform
• Sensible comments
  • Comments are included with each method, to describe why it exists
  • Input parameters and output parameters described
  • Comments describe classes
• Variable names make sense

Other Enhancements #

Nice to have

• Sensible commits
  • Each commit to version control makes sense
• Testing
  • Prepare a brief description of test cases to run on your code
  • Prepare scripts/code for running the tests
  • Report on the test cases

Elements included with your submission:

• Project description
• Instructions on how to run your program or code
• Description of technologies used