Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Code reviews #5

Open
PrinceAyo1 opened this issue Mar 25, 2024 · 1 comment
Open

Code reviews #5

PrinceAyo1 opened this issue Mar 25, 2024 · 1 comment

Comments

@PrinceAyo1
Copy link

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?]
Yes it does, though incomplete as of yet

User stories
[Does the project meet the user stories for that week?]
Yes it does

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

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

Instructions
[Does everything work as expected or were there missing instructions?]
The instructions are still being worked on at the moment, but the ones available were clear

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

Flow of control
[ Can you follow the different paths the code might take?]
Yes we can

Naming
[Do variables and functions have clear and descriptive names?]
Comments could be improved to be more descriptive, but the functions were descriptive

Readability
[Do you understand the code?]
Yes, they are

@AdrianaIaffa
Copy link
Collaborator

Thank you :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants