diff options
Diffstat (limited to 'docs/Checkpoint.md')
| -rw-r--r-- | docs/Checkpoint.md | 55 |
1 files changed, 55 insertions, 0 deletions
diff --git a/docs/Checkpoint.md b/docs/Checkpoint.md new file mode 100644 index 0000000..b5454e4 --- /dev/null +++ b/docs/Checkpoint.md @@ -0,0 +1,55 @@ +# Project Title + +Team members: + +- Name1 +- Name2 +- Name3 + +## Summary Description + +Reiterate the summary description of the overall goal of the project (updated as +necessary from the Proposal document). + +## Checkpoint Progress Summary + +Give a summary of the progress made and lessons learned thus far. + +## Additional Details + +- List any external Rust crates required for the project (i.e., what + `[dependencies]` have been added to `Cargo.toml` files). +- Briefly describe the structure of the code (what are the main components, the + module dependency structure). +- Pose any questions that you may have about your project and/or request + feedback on specific aspects of the project. + + +*** +*** + +The following should be deleted from the checkpoint document, but is included in the initial `Checkpoint.md` file for reference. + +## Final Project Rubric + +- Correctness (15%) + - Free of compilation errors and warnings. + - Correctly accomplishes the goals of the project. + - Correctness is supported by suitable testing. +- Style/Design (15%) + - Project applies one or more elements of Rust design: + - Uses traits. Minimally, makes use of traits from the Rust Standard Library (e.g., `PartialEq` and `Iterator`). Better, implements appropriate traits for the types defined for the project. Best, defines and uses novel traits for the project. + - Uses `struct` and `enum` definitions appropriately. + - Uses types to capture invariants. + - Uses modules appropriately (e.g., place distinct data structures in distinct modules). +- Effort/Accomplishment (30%) + - How “big” is the project? + - A “small” project will have at least 500 Lines of Rust Code per team member. (Significantly less than that corresponds to a “tiny” project and would not be acceptable for this activity.) A “medium” or “large” project may have significantly more and would likely also correspond to a more “difficult” project (see below). + - How “difficult” was the project? + - An “easy” project that required trivial data structures and algorithms. Feedback about how to extend the project was ignored. (Projects falling into this category are likely to lose points in Style/Design as well.) + - A “moderate” project that applied basic course concepts, but did not require the group members to significantly challenge themselves or to learn something new. + - A “challenging” project that demonstrates significant thought in design and implementation. Clear that the group members challenged themselves and learned something new by undertaking the project. + - What work was done for the project? (This includes both the work embodied by the final submission and work not obvious from the final submission (e.g., approaches attempted but then abandoned, suitably described).) + - Did the project require learning advanced features? + - Did all team members contribute to the project? +- Presentation (10\%) |