fac28 / code-reviews

0 stars 0 forks source link

Code Crafters - code review #1

Open ghost opened 1 year ago

ghost commented 1 year ago

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?]

Your README looks good. You have explained the Why, What and How of your project.

User stories

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

Your project meets almost all the user stories for the agency project. When using tab to navigate your website, it skips the "What We Do" section.

Learning outcomes

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

Your project meets many learning outcomes for this week. You could try using CSS variables for the colour scheme to attain your last learning outcome. (Sorry if we've missed your use of variables!)

UI bugs

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

After you hit submit, you are re-directed to a blank page.

Instructions

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

Everything worked as expected.

File structure

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

You could split the CSS and JavaScript into modular files to strengthen your structure.

Flow of control

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

Top marks for this!

Naming

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

Top marks for this too!

Readability

[Do you understand the code?]

Yes, we could understand your code at a glance.