From 85e5a4ea17194d8295a9e3fed59e8e09ed59261c Mon Sep 17 00:00:00 2001 From: Borja Sotomayor Date: Thu, 2 May 2024 17:18:26 -0500 Subject: [PATCH] Updated website --- projects/project3_rubric.html | 33 +++++++++++++++++++++++++++++++-- 1 file changed, 31 insertions(+), 2 deletions(-) diff --git a/projects/project3_rubric.html b/projects/project3_rubric.html index e8676e6..50188ec 100644 --- a/projects/project3_rubric.html +++ b/projects/project3_rubric.html @@ -103,6 +103,7 @@
  • Code Quality
  • Correctness
  • Design
    • +
  • Style
  • Other Code Quality Issues
    • @@ -165,7 +166,7 @@

    Submission Timeline

  • If you are scoring an N on the tests in your initial submission, you have nothing to -worry about. You can make a resubmission to raise your test score to an S.to

    • +worry about. You can make a resubmission to raise your test score to an S.

  • If you skip the initial submission, or score a U in the tests, we reserve the right to regrade your code for Code Quality in the resubmission.

    • @@ -269,6 +270,34 @@

    Design

    Repeating ICMP message creation logic in multiple places in your code, instead of writing a general-purpose “create an ICMP message” function

    +
    +

    Style

    +

    We will be checking your general adherence to +our Style Guide +and, while we will not be checking that you follow every minute aspect of our +style guide, we do expect you to follow a consistent style that +asymptotically approaches the one specified in our style guide. +That said, there are certain aspects we will be paying more +attention to:

    +
      +

    • Documenting functions: Every function written by you must have +a function comment with a brief description +of what the function does, and a description of the parameters and the +return value. Please note that not documenting your functions at all +(as opposed to doing so inconsistently or not following the style guide) +is considered a major issue.

      • +

    • Consistent indentation: Your code must follow one of the +allowed indentation styles consistently.

      • +

    • Clarity: Your code must be easy to read and understand. This +is a fairly subjective aspect, but remember that things like using +variable names without descriptive names or using magic numbers will +usually make your code harder to read.

      • +

    • [Major Issue] Using global variables, except when defining +compile-time constants.

      • +

    • [Major Issue] Using goto statements, except in the very limited cases +described in the style guide.

      • +
    +

    Other Code Quality Issues

    There are a couple of other issues that we care about across all projects: