Open vavalverde opened 1 month ago
Line 9 | JS-08 description can be made into JSDoc https://github.com/visualizing-your-future/visualizing-your-future/blob/a7529902b026a223935d40751dee0bbbc4f320a9/app/imports/ui/pages/ClientDataImport.jsx#L9
Line 20 | JS-01 Stuffs could be more descriptive https://github.com/visualizing-your-future/visualizing-your-future/blob/a7529902b026a223935d40751dee0bbbc4f320a9/app/imports/ui/pages/ClientDataImport.jsx#L20
Line 17 | Design-05 comment probably not needed https://github.com/visualizing-your-future/visualizing-your-future/blob/a7529902b026a223935d40751dee0bbbc4f320a9/app/imports/ui/pages/ClientDataImport.jsx#L17
ESLINT-01-02 No errors currently
JS-01 Name could be ExcelFileUploader but probably not necessary https://github.com/visualizing-your-future/visualizing-your-future/blob/a7529902b026a223935d40751dee0bbbc4f320a9/app/imports/ui/components/FileInput.jsx#L6
Line 14 | JS-04 can destructure line https://github.com/visualizing-your-future/visualizing-your-future/blob/a7529902b026a223935d40751dee0bbbc4f320a9/app/imports/ui/components/FileInput.jsx#L14
Line 23 | JS-01 names can be more descriptive https://github.com/visualizing-your-future/visualizing-your-future/blob/a7529902b026a223935d40751dee0bbbc4f320a9/app/imports/ui/components/FileInput.jsx#L23
Design-08 the padding can be moved to css https://github.com/visualizing-your-future/visualizing-your-future/blob/a7529902b026a223935d40751dee0bbbc4f320a9/app/imports/ui/components/FileInput.jsx#L72 https://github.com/visualizing-your-future/visualizing-your-future/blob/a7529902b026a223935d40751dee0bbbc4f320a9/app/imports/ui/components/FileInput.jsx#L86
Line 13 | JS-08 can use JSDoc comment to describe expected functionality https://github.com/visualizing-your-future/visualizing-your-future/blob/a7529902b026a223935d40751dee0bbbc4f320a9/app/imports/ui/components/FileInput.jsx#L13
ESLINT-01-02 No errors current
FileInput.jsx
Please add more comments.
I think style should be more in style sheet incase we need to call it somewhere else in the website.
ClientDataImport
L13-15 use /**/ instead of // since it’s multiline
ClientDataImport.jsx
FileInput.jsx
Comments:
Naming:
Design-08: Ensure code is DRY.
Design-05: Ensure comments are appropriate.
Review 02
Design-05: Line 9 comment should be updated to remove references of Stuff. It could also be modified into a JS-Doc comment to underline its documentation of the file, e.g.:
/**
* Renders a table containing data from the customer's file.
* FileInput stores the user's input data
* Returns a container displaying the data from FileInput
*/
Design-05: Would be helpful to see comments at each function for more code transparency (i.e. Lines 13, 32, 37). Would also be good to expand on JS-Doc comment.
Overview
In a separate document create a list in accordance with the checklist of issues you find. It may be helpful to link the code and include the checklist section it falls under. This is due Monday preferably at the start of our designated class time. Do not post the comment before then!
Example
Review Branch
review-02
Files to review
ClientDataImport.jsx FileInput.jsx
Checklists
Design JS
Due date
9/23/24
For more information The review process is documented at: http://courses.ics.hawaii.edu/ics414f24/morea/review/reading-idpm-review.html