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 Cleanup #41

Open
1 of 7 tasks
trentgoing opened this issue Jul 10, 2020 · 0 comments
Open
1 of 7 tasks

Code Cleanup #41

trentgoing opened this issue Jul 10, 2020 · 0 comments

Comments

@trentgoing
Copy link

trentgoing commented Jul 10, 2020

Good stuff!  Beyond the other issues opened that have specific code review commentary, please take some time to look through the following before the end of your project!

  • Informative Readme - check Learn for more details but the Readme will be the welcome mat for your project.  Update it to convey whatever you hope the reader should know.

  • Variable declaration - Are you using var or let?  Should some variables be const?

  • Variable/file naming conventions - This might be pointed out specifically in some cases, but are your variables and components named appropriately?  Things may have changed significantly from the time you first defined them to the end.  Make sure the names still make sense.

  • Specific, testable functions - Are you breaking functionality down enough?  Can important functionality be discretely verified or is it part of a larger class or method?  

  • Testing - Are your tests meaningful?  What are the critical parts of your application, and are they covered?

  • Error Handling - How are errors being caught?  Are errors thrown descriptive and helpful?

  • Logging - console.log statements should probably be removed.

Further Reading:

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

1 participant