Skip to content

Commit

Permalink
Updated website
Browse files Browse the repository at this point in the history
  • Loading branch information
@borjasotomayor
borjasotomayor committed Nov 6, 2024
1 parent b005c05 commit 198108b
Showing 1 changed file with 163 additions and 0 deletions.
163 changes: 163 additions & 0 deletions projects/project1_rubric.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,13 @@
<li><a class="reference internal" href="#other-code-quality-issues">Other Code Quality Issues</a></li>
</ul>
</li>
<li><a class="reference internal" href="#resubmission">Resubmission</a><ul>
<li><a class="reference internal" href="#required-documentation">Required Documentation</a></li>
<li><a class="reference internal" href="#project-1b-submissions-with-two-s-s">Project 1B Submissions with two S’s</a></li>
<li><a class="reference internal" href="#submitting">Submitting</a></li>
<li><a class="reference internal" href="#resubmission-grading">Resubmission Grading</a></li>
</ul>
</li>
</ul>
</li>
</ul>
Expand Down Expand Up @@ -486,6 +493,162 @@ <h3>Other Code Quality Issues<a class="headerlink" href="#other-code-quality-iss
</ul>
</section>
</section>
<section id="resubmission">
<h2>Resubmission<a class="headerlink" href="#resubmission" title="Link to this heading"></a></h2>
<p>When you receive your graded Project 1B, you can make a resubmission to address
any feedback you received in Projects 1A and/or 1B. This may increase your scores
in those projects.</p>
<p>While the project is divided into two parts (1A and 1B), remember that Project 1B
builds on Project 1A, As such, you should think about your
resubmission as a final cumulative submission that addresses any remaining issues
in your Project 1B submission (i.e., you should not think in terms
of making two separate resubmissions, one for 1A and another for 1B, with different
code for each submission).</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>If you scored two S’s in your initial submission for Project 1B, but not in your initial Project 1A
submission, you do not need to make any further changes to your Project 1B
code to bump your 1A scores up to two S’s. However, we do still need you
to make an (abbreviated) resubmission. If you are in this situation, please
skip to “Project 1B Submissions with two S’s” below.</p>
</div>
<section id="required-documentation">
<h3>Required Documentation<a class="headerlink" href="#required-documentation" title="Link to this heading"></a></h3>
<p>Making a resubmission involves not just addressing the feedback we gave you, but
also preparing some documentation explaining the changes you made to your code.
You should consider this documentation as important as the changes you are making
to your code: <strong>resubmissions that do not include the information requested below
WILL NOT BE GRADED</strong>.</p>
<p>If you decide to make a resubmission, you <strong>MUST</strong> add a <code class="docutils literal notranslate"><span class="pre">RESUBMISSION.md</span></code> file
in the root of your repository using the following template: (the exact sections
are explained below)</p>
<div class="highlight-markdown notranslate"><div class="highlight"><pre><span></span><span class="gh">Project 1 Resubmission</span>
<span class="gh">======================</span>

Team members:
<span class="k">-</span><span class="w"> </span>TEAM MEMBER 1 (CNETID1)
<span class="k">-</span><span class="w"> </span>TEAM MEMBER 2 (CNETID2)

<span class="gu">Rubric items you have addressed</span>
<span class="gu">-------------------------------</span>
&lt;COMPLETE THIS SECTION&gt;

<span class="gu">Rubric items you have NOT addressed</span>
<span class="gu">-----------------------------------</span>
&lt;COMPLETE THIS SECTION&gt;

<span class="gu">Substantial new code added to your submission</span>
<span class="gu">---------------------------------------------</span>
&lt;COMPLETE THIS SECTION&gt;

<span class="gu">Changes made to pass additional tests</span>
<span class="gu">-------------------------------------</span>
&lt;COMPLETE THIS SECTION&gt;

<span class="gu">Other changes</span>
<span class="gu">-------------</span>
&lt;COMPLETE THIS SECTION&gt;
</pre></div>
</div>
<p>Below you can find more details on each of the sections. If you are not providing any
information in a given section, please do not remove the section. Instead, just write
<code class="docutils literal notranslate"><span class="pre">N/A</span></code> below it.</p>
<ul>
<li><p><strong>Team members</strong>: Ordinarily, this would be the same two team members who made the original submission.
However, if you worked individually on the resubmission (because your teammate was happy with the
original submission, and didn’t want to work further on it), please make sure to note this here.</p></li>
<li><p><strong>Rubric items you have addressed</strong>: Rubric items that appear selected on Gradescope (under “Manual Grading”)
represent issues that had an impact on your Code Quality score. To facilitate the work of the
graders, you must list each rubric item you have addressed, with the following information:</p>
<ul class="simple">
<li><p>The rubric item description, exactly as it appears on Gradescope.</p></li>
<li><p>1-2 sentences explaining how you addressed the rubric item.</p></li>
<li><p>If the work you did on the rubric item is limited to a few lines of code, specify the filename and line number(s),
If your work on this rubric item involved deeper changes to your code, you do not need to list every single line
of code you changed, but you should try to give the graders a general sense of where you made the changes, including
a few examples if possible
(e.g., “I combed through the code to make sure I was using descriptive variable names; for example, I changed <code class="docutils literal notranslate"><span class="pre">c</span></code> to
<code class="docutils literal notranslate"><span class="pre">channel</span></code> in several functions”, “I reorganized functions <code class="docutils literal notranslate"><span class="pre">foo()</span></code>, <code class="docutils literal notranslate"><span class="pre">bar()</span></code>, and <code class="docutils literal notranslate"><span class="pre">baz()</span></code> as requested”, etc.)</p></li>
</ul>
<p>Bear in mind that the Project 1A rubric items are a subset of the Project 1B rubric items. This means that…</p>
<ul class="simple">
<li><p>If your initial Project 1B submission already addressed a rubric item from Project 1A (and the rubric
item was no longer selected in your graded Project 1B), it is enough to say “This rubric item was addressed
in Project 1B”</p></li>
<li><p>If you scored an N in Code Quality in Project 1A, but then scored an S in Code Quality
in Project 1B, you do not need to explain how you addressed each individual rubric item.
Instead, please include the following text in this section: “We earned an S in Code Quality
in Project 1B”</p></li>
</ul>
</li>
<li><p><strong>Rubric items you have NOT addressed</strong>: It is also important that you let us know what rubric items you
decided not to address, as this will expedite the work of the graders. For these rubric items, it is enough
to provide a list of the rubric item descriptions (exactly as they appear on Gradescope)</p></li>
<li><p><strong>Substantial new code added to your submission</strong>: If you added substantial new code that was not present in your
original submission (e.g., if your original submission did not implement several commands, and you have now included
new code to implement those commands), you must specify the affected files, as well as the new functionality that
is added by the new code. For example, you could include something like this:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Modified</span> <span class="n">files</span><span class="p">:</span> <span class="n">ctx</span><span class="o">.</span><span class="n">h</span><span class="p">,</span> <span class="n">handlers</span><span class="o">.</span><span class="n">c</span>

<span class="n">Locks</span><span class="p">:</span> <span class="n">Added</span> <span class="n">locks</span> <span class="n">X</span><span class="p">,</span> <span class="n">Y</span><span class="p">,</span> <span class="ow">and</span> <span class="n">Z</span> <span class="ow">in</span> <span class="n">chirc_ctx_t</span>

<span class="n">JOIN</span> <span class="ow">and</span> <span class="n">PART</span><span class="p">:</span> <span class="n">Implemented</span> <span class="n">the</span> <span class="n">handlers</span> <span class="k">for</span> <span class="n">these</span> <span class="n">commands</span> <span class="ow">in</span> <span class="n">handlers</span><span class="o">.</span><span class="n">c</span>

<span class="n">QUIT</span><span class="p">:</span> <span class="n">Updated</span> <span class="n">the</span> <span class="n">QUIT</span> <span class="n">handler</span> <span class="n">to</span> <span class="n">relay</span> <span class="n">the</span> <span class="n">QUIT</span> <span class="n">to</span> <span class="n">users</span> <span class="n">on</span> <span class="n">the</span> <span class="n">same</span> <span class="n">channel</span> <span class="k">as</span> <span class="n">the</span> <span class="n">user</span><span class="o">.</span>
</pre></div>
</div>
</li>
<li><p><strong>Changes made to pass additional tests</strong>: If you made changes to your code with the goal of passing more tests,
please specify your original test score, and the new test score. If your work only involved a few minor bug fixes,
please let us know you did this (but you do not need to specify the exact changes you made). On the other hand,
if you skipped parts of Project 1B in your original submission, and have written entirely new code, please make
sure you have specified this as part of the “substantial new code”, and that you also specify that doing so
allowed you to pass additional tests.</p></li>
<li><p><strong>Other changes</strong>: If you made other changes to your code, such as refactoring large parts of your code, make
sure to specify this too.</p></li>
</ul>
<p>Once again, if you do not include a <code class="docutils literal notranslate"><span class="pre">RESUBMISSION.md</span></code> file with the above information,
your resubmission <strong>will not be graded</strong>.</p>
</section>
<section id="project-1b-submissions-with-two-s-s">
<h3>Project 1B Submissions with two S’s<a class="headerlink" href="#project-1b-submissions-with-two-s-s" title="Link to this heading"></a></h3>
<p>If you scored two S’s in your initial submission for Project 1B, but not in your
original Project 1A submission, you do not need to submit all the documentation
requested above. However, we do still need you to make a resubmission so we know
you want us to revise your Project 1A submission.</p>
<p>In this resubmission, you do not need to make any changes to your Project 1B
code, and can simply resubmit the exact same code your submitted in our original
Project 1B submission. All you need to do is add a <code class="docutils literal notranslate"><span class="pre">RESUBMISSION.md</span></code> file
with the following contents:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Project</span> <span class="mi">1</span> <span class="n">Resubmission</span>
<span class="o">======================</span>

<span class="n">Team</span> <span class="n">members</span><span class="p">:</span>
<span class="o">-</span> <span class="n">TEAM</span> <span class="n">MEMBER</span> <span class="mi">1</span> <span class="p">(</span><span class="n">CNETID1</span><span class="p">)</span>
<span class="o">-</span> <span class="n">TEAM</span> <span class="n">MEMBER</span> <span class="mi">2</span> <span class="p">(</span><span class="n">CNETID2</span><span class="p">)</span>

<span class="n">We</span> <span class="n">earned</span> <span class="n">two</span> <span class="n">S</span><span class="s1">&#39;s in Project 1B, but not Project 1A.</span>
</pre></div>
</div>
<p>Note: If you already earned two S’s in both Project 1A and 1B, do not make a resubmission
(it will be ignored). If you have questions about any of the feedback you received,
please post a question on Ed.</p>
</section>
<section id="submitting">
<h3>Submitting<a class="headerlink" href="#submitting" title="Link to this heading"></a></h3>
<p>You will submit your code through the “Project 1 (Resubmission)” assignment on Gradescope.
Other than that, you should follow the same submission instructions as in the original submissions.</p>
</section>
<section id="resubmission-grading">
<h3>Resubmission Grading<a class="headerlink" href="#resubmission-grading" title="Link to this heading"></a></h3>
<p>In general, if you are making a resubmission that only involved addressing rubric items, without adding substantial
new code to your submission, there is a very high likelihood that addressing all the rubric items will bump your Code
Quality score to an S. You may leave up to two non-major rubric items unaddressed.</p>
<p>On the other hand, if you are making a resubmission that involves adding substantial new code, please bear in mind
that the graders could identify issues in that new code that will impact your Code Quality score. Please
make sure to carefully review the <a class="reference external" href="project1_rubric.html">Project 1 Rubric</a> so you know what the graders will be looking at.</p>
</section>
</section>
</section>


Expand Down

0 comments on commit 198108b

Please sign in to comment.