Open
Conversation
First draft of README
upieez
reviewed
Jan 5, 2022
upieez
left a comment
There was a problem hiding this comment.
What went well
- Great documentation in your README.md and your Wiki
- Frequent commits
- Great use of third-party resources for your design (NES.css) and your hints
- It is mobile responsive
- Great use of JSDoc for your functions
- Your function names are well written and easy to read and understand
- Excellent customization (through the options menu) and the secret codes
What can be improved
- Consider splitting the functions in your
script.jsinto different files for better separation of concerns - Having unit tests is good but for this particular project, the time spent on understanding and implementing it could have been dedicated on other areas such as working on the "More Comfortable"
- Creative use of background image for your cards but they are usually not very good for accessibility. Instead, you could consider using
imgtags with analttext to help with accessibility - Consider omitting comments that is already self-explanatory so as not to clutter your codebase
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Please fill out the survey before submitting the pull request. Thanks!
🚀🚀🚀🚀🚀🚀🚀🚀🚀🚀🚀🚀🚀🚀🚀🚀
How many hours did you spend on this assignment?
Probably 30-40 hours
Please fill in one error and/or error message you received while working on this assignment.
What part of the assignment did you spend the most time on?
UI (css) and getting the game as complete as possible (bug fixing, edge cases, icon/image editing, etc)
Comfort Level (1-5):
4 because there are several parts of my project that I know only at the basics level
Completeness Level (1-5):
4 because I didn't really do More Comfortable
What did you think of this deliverable?
Fun
Is there anything in this code that you feel pleased about?
UI, which is a challenge for me but I pushed through it, and also the extra stuff that I was able to implement to make the game more fun and complete