Assignment submission checklist

Written by Sam Redmond and Keith Schwarz

This handy checklist is designed to help make sure your code is fully ready to go before you submit it. Before you send it in for, take a few minutes to work through this checklist.

Functionality

✅ I’ve double-checked the assignment handout and made sure that what my code does matches what it’s expected to do.
✅ I’ve reviewed my code one line at a time. I understand each line of code I’ve written, why it’s there, and why it’s necessary.

Test cases

✅ I've run all of the provided test cases against my code and resolved any test failures.
✅ I've supplemented the provided test cases with tests of my own. For each part of the assignment, I’ve written at least one test case to make sure it works well in the common case.
✅ For each part of the assignment, I’ve thought of at least one edge case that could cause problems and designed a test case for it. (And ideally, I’ve done this for multiple edge cases!)

Style

✅ I’ve read the CS106B Style Guide at least once in its entirety and asked questions to my section leader about any parts I don’t understand.
✅ Each of my functions, conceptually, performs a single task.
✅ The dense parts of my code are commented, and those comments describe what the code accomplishes rather than merely restating the logic in plain English.
✅ Every function I’ve written has a comment preceding it that explains what the function does, what its parameters are, and what its return value (if any) means.
✅ I’ve updated the comments at the top of each of the files I’ve edited with an explanation about what the code in that file does and anything unusual that a reader should keep an eye out for.
✅ For each container class I’ve used (Vector, Map, etc.), I can justify why I chose that particular container type rather than another container type.
✅ The code I’ve written does not use any global variables.
✅ The code I’ve written does not use the goto keyword.
✅ All of my variables and functions clear and descriptive names.

Final Submission

✅ I’ve auto-indented my code in Qt Creator.
✅ I’ve handled all the TODOs in the code and removed any comments from the starter files describing what I need to do.
✅ I’ve removed all cout statements left in the code that I used for debugging purposes.
✅ I’ve removed all commented-out blocks of code that are no longer necessary.
✅ I’ve read the “Submit" section of the assignment handout and confirmed that I’m submitting all of the required files.