Milestone 6
Due date: April 30, 2025 (with HW10)
Purpose: The goal of Milestone 6 is review your code and get feedback from your peers.
Task (requirements for passing this Milestone):
Open a Github Issue in your project repository with the title “Milestone 6 Code Review” and the following content:
- A brief description of your project research questions
- A brief description of the planned digital artifact
Add a peer as a collaborator to your project repository so that they can access your codebase and the issue created. Indicate in the Github Issue who you have added as a collaborator and what file you want them to review.
Review the code of one of your peers. For each peer, write a review in the Github Issue that includes the following:
- A brief description of the code you reviewed
- A list of things that you think the author did well
- A list of things that you think the author could improve
- A list of any questions you have about the code
When considering the code, think about the following:
- Correctness - Does the code work as expected?
- Readability - Is the code easy to understand?
- Documentation - Is the code well documented?
- Format/Style - Is the style of the code consistent?
- Reusability - Does the code use functions appropriately to make code reusable?
- Testing - Is the code well tested?
- Respond to the reviews of your code. For each review, write a response that includes the following:
- A brief description of the changes you made based on the feedback
- A list of any questions you have about the feedback