Skip to content

Commit c68ea57

Browse files
authored
Create code_review.yml
1 parent 08b9271 commit c68ea57

File tree

1 file changed

+64
-0
lines changed

1 file changed

+64
-0
lines changed
Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
name: Code Review
2+
description: A code review conducted with a Technical Leader (TL) or the course instructor.
3+
title: "Code Review"
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Please respond to the following questions about the project.
9+
- type: checkboxes
10+
attributes:
11+
label: Functional requirements
12+
description: Check each of the following satisfied functional requirements
13+
options:
14+
- label: "Code solves the issue presented"
15+
required: True
16+
- label: "Code functions, even if not fully solving the issue presented"
17+
required: True
18+
- label: "Performance of the code is acceptable"
19+
required: True
20+
- type: checkboxes
21+
attributes:
22+
label: Code style and legibility
23+
description: Check each of the following checkboxes that describe code legibility
24+
options:
25+
- label: The code contains comments
26+
required: True
27+
- label: Variable names are accurate and appropriate
28+
required: True
29+
- label: The code is easy to read
30+
required: True
31+
- label: The code is formatted correctly
32+
required: True
33+
- type: markdown
34+
attributes:
35+
value: |
36+
Conduct a short walkthrough with the programmer, marking the topics appropriately explained.
37+
- type: checkboxes
38+
attributes:
39+
label: Code walkthrough
40+
description: Check each of the following checkboxes that describe code legibility
41+
options:
42+
- label: The author understands the arithmetic operators used
43+
required: True
44+
- label: The author described the role of variables with adequate detail
45+
required: True
46+
- label: The author clearly connected the code to the problem presented in the assignment
47+
required: True
48+
- label: The author described their process well, communicating confidence and understanding of their own code
49+
required: True
50+
- type: textarea
51+
attributes:
52+
label: The Good, The Bad, The Ugly
53+
description: Write a short note with at least 3 aspects done well, and 3 aspects on which the code could be improved
54+
value: |
55+
Positives
56+
1.
57+
2.
58+
3.
59+
Improvements
60+
1.
61+
2.
62+
3.
63+
validations:
64+
required: true

0 commit comments

Comments
 (0)