Class Rubrics: Grading

[bayaj0110]

CS 461 Project Proposal Rubric

For D (1)

• [x] Typos are minimal.
• [x] Project has a clear and short title.
• [x] Project's main features are clearly outlined.
• [x] At least one comparable solution is presented and contrasted to the project.
• [x] The proposal is available as a GitHub page.

For C (2)

All requirements for D plus:

• [x] No obvious sentence structure errors or typos.
• [x] Document is clearly separated into logical sections.
• [x] References section is present and reasonably complete, with a minimum of 3 references.
• [x] At least two comparable solutions are presented and contrasted to the project.
• [x] A description of the relevant technologies to be used (language(s), framework(s), libraries) is present.

For B (3)

All requirements for C, plus:

• [x] The first line and paragraph clearly describe the project at a high level.
• [x] Each paragraph has a clear purpose, which is apparent in the first sentence.
• [x] Reference sources are properly cited in the main text.
• [x] Effective use of Markdown syntax for headings, links, and itemized lists.
• [x] An overview of the different components of the project, including their roles and connections, is present. this should meet since I added this on my proposal.md

For A (4)

All requirements for B, plus:

• [x] References section thoroughly covers all pertinent sources, with a minimum of 7 sources.
• [x] Alternative technologies are considered and contrasted to the choices made.
• [x] Italicized and bolded text is used to emphasize key parts.
• [x] The comparison of alternative technologies makes a compelling case for the choices made.

[bayaj0110]

CS 461 Project Check-in Rubric

For D (1)

• [x] There is a GitHub repository hosting the project code.
• [x] Code is separated into multiple files with a clear description of each file's role.
• [x] There are no commented-out pieces of code.

For C (2)

All requirements for D, plus:

• [x] GitHub Issues are used to monitor progress on the project code (Expected: at least 3 code-specific issues).
• [x] Multiple commits have been made that add code to the project.
• [ ] Functions are relatively small in size. ??
• [x] Functions and variables have well-chosen descriptive names.
• [x] Code formatting is consistent.
• [ ] Code duplication has been avoided. ??
• [x] The application runs with no errors.

For B (3)

All requirements for C, plus:

• [x] Commits have succinct messages that appropriately describe each commit.
• [x] There are automated tests in place.
• [x] There is at least one key piece of functionality implemented.
• [x] Documentation-style comments at the top of each file describe the file.
• [ ] Defined constants are used instead of "magic values". ??

For A (4)

All requirements for B, plus:

• [x] Commits are atomic (each addressing a single concern).
• [x] Long lines of code are avoided.
• [x] Custom classes are used to model the application's data.
• [ ] The automated tests validate the implemented features. need to make test for every pages
• [x] There are at least two key pieces of functionality implemented.
• [x] Project has a clear file structure.

[bayaj0110]

Tutorial Rubric

Routing with Next.js

For D (1)

• [ ] The tutorial files are laid out under a docs/tutorial directory, and there is at least an index.md file to start everything off.
• [ ] An introduction is present and addresses the learning objectives of the tutorial.
• [ ] A prerequisites section is present, listing the expected knowledge and installed tools needed to follow along.
• [ ] Steps are present that walk the user through examples of X.
• [ ] At least one example of relevant code or screenshot is included.
• [ ] The tutorial is created as a webpage as part of a GitHub Pages build.

For C (2)

Everything for D, plus:

• [ ] The tutorial is divided into clear sections that break the content into coherent blocks.
• [ ] The instructions contain multiple relevant code blocks and/or screenshots to guide the reader through the steps.
• [ ] Valid markdown constructs are used to structure the document appropriately.
• [ ] Links to relevant official documentation are included in a "See also" section.
• [ ] A summary/conclusion section/page is included.
• [ ] The document avoids grammatical and syntax errors.

For B (3)

Everything for C, plus:

• [ ] The tutorial includes at least 2 practice exercises for the reader to explore beyond what the tutorial provides.
• [ ] Links use the fragment part of a URL to target specific sections within the linked page where possible.
• [ ] The tutorial is broken up into multiple markdown files, each with a clear purpose. The index.md file acts as a table of contents. Each file has clear links to the next and previous files.
• [ ] Appropriate markdown constructs are used to indicate anything that is code and to emphasize important terms.
• [ ] Images are appropriately scaled to not overwhelm the page.
• [ ] The tutorial can be followed by someone with the prerequisite tools.

For A (4)

Everything for B, plus:

• [ ] Relevant links to official documentation are included at appropriate points throughout the text.
• [ ] Code blocks are marked for syntax coloring in the correct programming language/shell.
• [ ] The tutorial provides comprehensive coverage of the essential features of the targeted concept.
• [ ] The tutorial flows in a natural and logical way, introducing progressively more complex concepts over time.
• [ ] The target audience for the tutorial is clearly defined in the introduction, and the content is tailored to the technical level of that audience.