fac28 / code-reviews

0 stars 0 forks source link

[George Klemperer & Eunbyul Na - Agency Project] - code review #7

Open isobelbutler opened 1 year ago

isobelbutler commented 1 year ago

Immediate thoughts - need to put these into template:

README

[Does the README describe the project using the subheadings: Why?, What?, How? i.e. Why have you created this repo, what does it do, how does it do it?]

User stories

[Does the project meet the user stories for that week?]

Learning outcomes

[Does it demonstrate the learning outcomes for that week?]

UI bugs

[Can you see any obvious bugs or areas to improve?]

Instructions

[Does everything work as expected or were there missing instructions?]

File structure

[When you open the project in your editor, does the file structure make sense?]

Flow of control

[ Can you you follow the different paths the code might take?]

Naming

[Do variables and functions have clear and descriptive names?]

Readability

[Do you understand the code?]