issues
search
Dance-Data-Project
/
smith-capstone-23
MIT License
0
stars
1
forks
source link
Rose - code review
#44
Closed
raevard
closed
1 year ago
raevard
commented
1 year ago
File Management
Are all code and data files organized into appropriate folders?
[x] Always
[ ] Sometimes
[ ] Never
Comments:
Do all file names in the repository (including .Rmd, .csv, .md) accurately describe the content of the file?
[x] Always
[ ] Sometimes
[ ] Never
Comments:
Commenting
Are all code chunks or distinctive code sections commented with enough detail such that an external reviewer can interpret their purpose?
[ ] Always
[ ] Sometimes
[ ] Never
Comments:
Are all data frames and functions commented with sufficient detail?
[x] Always
[ ] Sometimes
[ ] Never
Comments:
Efficiency
Is at least one function from each imported package referenced in the code?
[ ] Always
[x] Sometimes
[ ] Never
Comments:
Are functions implemented to avoid repeating lines of code?
[ ] Always
[x] Sometimes
[ ] Never
Comments:
Does each section of the code have a distinctive purpose? (In other words, could you devise a meaningful "table of contents" for your code?)
[x] Always
[ ] Sometimes
[ ] Never
Comments:
Style
Does the code adhere to the conventions outlined in the team's style guide?
[x] Always
[ ] Sometimes
[ ] Never
Comments:
Do all variable and function names accurately describe their content?
[x] Always
[ ] Sometimes
[ ] Never
Comments:
Are new lines used effectively such that code can be read without having to scroll across the screen?
[x] Always
[ ] Sometimes
[ ] Never
Comments:
Have all unused lines of code been removed from the file?
[ ] Always
[x] Sometimes
[ ] Never
Comments:
File Management
Are all code and data files organized into appropriate folders?
Do all file names in the repository (including .Rmd, .csv, .md) accurately describe the content of the file?
Commenting
Are all code chunks or distinctive code sections commented with enough detail such that an external reviewer can interpret their purpose?
Are all data frames and functions commented with sufficient detail?
Efficiency
Is at least one function from each imported package referenced in the code?
Are functions implemented to avoid repeating lines of code?
Does each section of the code have a distinctive purpose? (In other words, could you devise a meaningful "table of contents" for your code?)
Style
Does the code adhere to the conventions outlined in the team's style guide?
Do all variable and function names accurately describe their content?
Are new lines used effectively such that code can be read without having to scroll across the screen?
Have all unused lines of code been removed from the file?