Feedback Addressed from Peer Reviews - Githubissues

DSCI-310-2024 / DSCI_310_Milestone_1_Group_3

DSCI 310 group 3 milestone project 1.

Other

0 stars 0 forks source link

Feedback Addressed from Peer Reviews #28

Open selenashew opened 2 months ago

selenashew commented 2 months ago

DSCI 310 Group 3: Incorporating Peer Review Feedback April 11, 2024

After looking through all four peer reviews received, all peer reviews noted that our code was good and ran well
Most of our issues surrounded our documentation, especially the README, CONTRIBUTING, and ipynb files
We have included our specific edits below for each documentation file as suggested from the peer reviewers:

README Edits:

Add specific usage examples (such as specific terminal commands)
Add dependencies & versions in the file
Fix the syntax & add code blocks for each command
Add description of how to run the entire analysis

CONTRIBUTING Edits:

Add guidelines as to how 3rd parties can contribute to the project
Elaborate on community guidelines
Specify how users can submit issues & contact the authors

Ipynb Edits:

Add authors (our names)
State & expand upon the research question
Expand the results & conclusions section
Discuss how the model performed

selenashew commented 2 months ago

Splitting up tasks:

Shawn to incorporate functions into the analysis repository
Selena to fix the README
Lesley to fix the ipynb file
Sri to fix the CONTRIBUTING file