Code peer review - Githubissues

INFO526-DataViz / project-final-Graph-Gurus

Graph Guru's team GitHub repository for Final Project from INFO 526 @ UArizona

https://info526-dataviz.github.io/project-final-Graph-Gurus/

0 stars 0 forks source link

Code peer review #6

Closed Priyarsha31 closed 9 months ago

Priyarsha31 commented 10 months ago

The following is the peer review of the project code by [name of team completing peer review]. The team members that participated in this review are

Athira Thekkemdathil Anilkumar - @AthiraThekkemadathilAnilkumar
Priyarsha Vallabhaneni - @Priyarsha31
Shalon Walter - @shalonwalter
Chethana Thondebhavi Shantha Kumar - @Chethana-16

1. Purpose of Code

[ * ] Clearly defined and understood
[ ] Ambiguous or unclear

2. Code Quality

[ * ] Code is clean, readable, and well-organized
[ ] Adequate comments explaining complex or tricky code sections
[ ] Variables, methods, and classes have meaningful names
[ ] Consistent code style (indentation, naming conventions, etc.)

3. Documentation

[ * ] Code documentation (e.g., comments) is sufficient
[ ] Readme or other documentation updated if necessary

4. Best Practices

[ ] No hardcoded values; constants used appropriately
[ ] Security and privacy concerns addressed (e.g., no sensitive data exposed)
[ * ] Code avoids repetition and promotes reusability

5. Additional Comments

Overall, the code looks pretty readable with appropriate comments.
The plots in the app also impressive.

6. Recommendation

[ ] Approved - ready to be merged
[ * ] Approved with minor issues - can be addressed later
[ ] Requires changes - provide feedback and request another review