Codewalks

Codewalks attempt to meet the following goals

1. Learn how to effectively communicate your solution, design and implementation to others.
2. Learn how to discuss pros and cons of a solution, design and implementation.
3. Evaluate and accept/reject feedback on your solution, design and implementation.
4. Be constructively critical of work presented to/by you.

Presentation

Some recommendations for your presentation

1. Present the problem you attempted to solve.
2. Provide a simple explanation in English of the problem.
3. Give examples providing inputs and outputs. Use these examples to nail down the problem.
4. If there are special cases that require attention, state them and explain the reason why these cases require attention.
5. Present an overview of your solution.
6. Provide a clear mapping of the problem's information to data/classes.
7. Provide an explanation of the role for each class.
8. Use a diagram (Class Diagram).
9. Provide a clear picture of the interactions between you classes.
10. Provide an explanation of how interactions in your code achieve the desired outcome.
11. Use an interactions/sequence diagram.
12. Show how tests capture the cases (special or otherwise) that you covered at the start of your presentation.

Codewalk Public General Rubric

This rubric describes the common, general points that we will always consider for all codewalks.

For each week's codewalk there will be specific, problem related points that we will be looking for that will very with each assignment.

The goal of our codewalks are

1. To train students to write well designed, well organized and well documented code.
2. To train students in explaining their logical solution(s) to their peers.
3. To train students in explaining how their design and implementation follows their logical solution.
4. To train students in listening and answering questions about their logical solution/design/implenentation.
5. To train students in discussing pros and cons of their logical solution/design/implementation and propose alternatives.

The goal of this rubric is to provide a set of areas/questions to consider both while you are preparing for your codewalk but also while you are listening to someone else's codewalk. These areas/questions attempt to focus on what we have found to be decisive characteristics of the solution/design/code that can expose flaws

Logical Solution

1. Can the presenter explain their logical solution in English?
2. Does the logical solution have clear steps?
3. Is the order of these steps clear?
4. Do the steps lead to a correct solution to the problem?
5. Can the presenter show using an example how their logical solution leads to a correct answer?

Design

1. Does the presenter clearly map information from the problem to data?
2. Does the presenter clearly map steps/operations in their design?
3. Does the design follow our design rules
4. One class one responsibility
5. One task one method
6. Only talk to your friends
7. Are pre-, post-conditions and invariants clearly stated? Are they correct?
8. Can the presenter list pros and cons of their design? Can we do better?
9. Were alternative designs considered? If so what lead to selecting the current design?

Implementation

1. Does the implementation follow the design?
2. Does the code map to the logical solution
3. Each step is clearly mapped
4. The presenter can walk through a concrete example and show how the code behaves
5. Code follows our rules
1. Meaningful names for class, fields, methods etc.
2. Proper separation of Client code, implementation etc.
3. No magic values
4. Documentation is clear and the code does in fact behave as documented
5. Cryptic methods
6. Proper use of abstraction
6. Can the presenter discuss the algorithmic complexity of their solution/implementation?

Presentation

1. Can you hear the presenter when they speak?
2. Do you understand the presenter when they speak?
3. Does the presenter use the correct terminology?
4. Does the presenter understand and answer the question asked?

Re-Grade Policy

If you believe we made a mistake when grading one of your problem sets, you may submit an re-grade request on Piazza. A re-grade request should be submitted within 7 days of receiving your grade

1. Start a private Piazza thread visible to all instructors
2. Have a subject line of the form re-grade request for Assignment N where N identifies the problem set whose grade is disputed
3. State your full name
4. state your CCIS ID
5. link to your GitHub repository
6. name your partner (if you have one for that problem set)
7. describe the mistake(s)
8. provide supporting evidence as necessary

Incomplete or improperly formatted re-grade requests may be ignored.

Our resolution of a re-grade request often forces us to take a closer look at your submission, and it is not unusual for that closer look to result in a lower grade instead of a higher grade for the problem set.