CMSE 495
This is the webpage for CMSE495 Data Science Capstone Course. These materials are provided as an Open Educational Resource (OER). Instructors interested in using these classroom resources should reach out to Dirk Colbry (colbrydi@msu.edu) who can provide all the materials and instructor notes.
Installation Code Review
Agenda (80 Minutes)
- (10 minutes) CATME Team Review
(50 minutes) Installation Code Reviews- (10 minutes) Annocements and check-in
- (80 minutes) Group meeting
CATME team review
When you get to class, log onto CATME and provide a review of you and your team’s performace on the slide development milestone.
Install Instruction Reviews
This is a team paring exercise. Your team will work with another team to review your projects unit tests. Split each of your teams into two groups of 2-3 people. Have your bigger group stay at your table to be the “Host Team” and the smaller group move to be the “Guest Team” at another table. Here is a list of how the teams should move around:
Once the mixed teams are formed, have the host team walk the guest team through the install instructions. If possible have them someone from the guest team try to install the software from scratch from either their personal laptop or a personal account such as the HPCC, jupyterhub or googlecolab.
Have the group members from the host team hold back and only give advice and support if there is a problem. The idea is to streamline the process so that the documentation and instructions are sufficient for someone outside of the host team to be able to install, test and use the software without needing to have help. As a group take lots of notes and review the unit tests and documentation to the host team some constructive feedback. If you are a member of the host team, use this as an opportunity to fix problems as they are discovered.
As a group, prepare a report for the instructor and the development team. This report should provide the following:
Clearly label which teams code is being evaluated.List of the evaluation group members with an indication about which capstone team they are on and their roles in the meeting.Was someone outside the development team able to install the software and get the unit tests working? If not, what was the problem?- ~~Briefly describe the completeness of the install instructions. Was the review team able to identify any missing steps.
Is there anything that needed to be added to the documentation to make the project easier to install and test?Was there anything you could add to the project to help make the project better?
This is a group effort, email the report to the instructors and cc the other members that are at the table (both host and guest teams).
Note, the above instructions may not work for all projects. Some projects may require a demonstration instead of an actual install due to software limitations. Make sure not to violate any NDA
Spring break next week! Nothing Due this Sunday, next deadline is the Sunday at the end of spring break (Check the schedule)!!!
Group meeting
Conduct a group meeting for the remainder of the hour. Check your project milestones, progress and make plans to practice and finish your presentation by next week.
Written by Dr. Dirk Colbry, Michigan State University
This work is licensed under a Creative Commons Attribution-NonCommercial 4.0 International License.