$29
Assignment #5 Solution
High-Level Requirements:
The assignment will be completed in 3 phases.
All your deliverables will be based on work you have done on GitHub.
Phase-I
Phase-II
Phase-III
Phase-I Requirements:
You have to create your GitHub account id as instructed in the tutorial.
For a student with the name John Doe with A number A12345678.
His id will be JSP18SCM78D.
In this ID J is the first character of his first name.
SP18SCM will be common for each student.
78 is the last two numbers of his A number.
D is the first character of his last name.
Once the TA receives all of your GitHub accounts you will be added as Collaborators to the master repository. For this, the TA will be sending out a mail to get all your created GitHub accounts. Use your hawk id while registering for your GitHub accounts. Do not use newly created email ids just for the assignment as GitHub may consider these id’s as Bots and remove them. You will be proceeding to the next step only after the TA sends out a mail confirming that you have been added as a collaborator.
Next you will be forking the repository SCM587SP18 from SPM587SP2018 GitHub organization to the GitHub account that you have created. This repository can be opened with the following URL.
https://github.com/SPM587SP18/SCM587SP18.git
Now using the URL given above you will login to the repository listed above. You will go to the issues tab and create a new issue.
The title of the issue will be as listed below. “<Your GitHub id adding first name” Example – “JFA17SCM78D adding first name”
This issue will be labeled using the labeling scheme listed below.
Labeling Scheme: Your Labeling Scheme follows the key:value
format “LabelName:LabelValue” for every label
Types of Labels: There are different types of labels, the following is the list of labels used for issues listed that you will use based on the first digit of your A-Number:
OriginationPhase:
If the first digit is odd number: use one of the values {Coding, Testing, Documentation, Field}
If the first digit is even number: use one of the values {Requirements, Design }
DetectionPhase:
If the first digit is odd number: use one of the values { Coding }
If the first digit is even number: use one of the values {Design}
Priority:
If the first digit is odd number: use one of the values { Major , Low}
If the first digit is even number: use one of the values {Medium, Critical}
Status:
If the first digit is odd number: use one of the values { Rejected, Completed }
If the first digit is even number: use one of the values { pendingReview , Approved, inProgress, }
Category:
If the first digit is odd number: use one of the values { Enhancement, Inquiry }
If the first digit is even number: use one of the values {Bug }
Address (You need 3 labels for Address, Latitude, and Longitude):
If the first digit is odd number: Use any McDonalds location that is in a zip code that ends up with odd number. For example, the student with A12345678 will google Mcdonalds locations and might pick this address (2438 W Cermak Rd, Chicago, IL 60623). And then uses this URL ( https://www.latlong.net/convert-address-to- lat-long.html ) to find the Lat and Long coordinate values:
If the first digit is even number: Use any McDonalds location that is in a zip code that ends up with even number
You will now clone the repository that you have forked into your account on to your local machine. This repository will contain files a.java, b.java, c.java, …, z.java. You will open the file that has the first character of your first name. Once you open the file you will enter your GitHub account id in a new line and save it.
Example – For John Doe with GitHub account JSP18SCM78D, he will open j.java and add his GitHub account username in a new line and save it. So j.java will contain JSP18SCM78D.
Now you will do a commit and then push this repository into your GitHub account. While making the commit you have to add your Issue number in the commit message in the following format.
Example – git commit –m “Fixes #<IssueNumber. <GitHub username first name added.”
Say for John Doe the issue he has created is Issue #24. His commit message will be as follows.
git commit –m “Fixes #24. JSP18SCM78D first name added”
10. Once that is done you will create a pull request to the master repository so that your changes can be merged onto the master repository. You will just create the pull request. It will be the TA who will accept your changes. Your pull request title should also be the exact same as your commit message.
This will complete your Phase 1. You will also need to submit two screenshots as the commit report for each phase. The last page in this document instructs you on how to capture those screen shots. Both the screenshots that you have captured need to be put in a pdf called Report_Phase1_<GitHubUsername.pdf for your phase I. Once your changes are all accepted in the master repository you will receive an email to commence Phase II. Then you will be following the Phase II instructions. Do not start Phase II till you have received the email to proceed with Phase II from the TA.
Phase-II Requirements:
You will open the master repository from your GitHub account and create a new issue.
This issues title will be as listed below. “<Your GitHub id adding last name” Example – “JSP18SCM78D adding last name”
This issue will be labeled using the labeling scheme listed below.
Labeling Scheme: Your Labeling Scheme follows the key:value
format “LabelName:LabelValue” for every label
Types of Labels: There are different types of labels, the following is the list of labels used for issues listed that you will use based on the last digit of your A-Number:
OriginationPhase:
If the last digit is odd number: use one of the values {Requirements, Design }
If the last digit is even number: use one of the values {Coding, Testing, Documentation, Field}
DetectionPhase:
If the last digit is odd number: use one of the values { Testing
}
If the last digit is even number: use one of the values {Field}
Priority:
If the last digit is odd number: use one of the values {Critical, Major }
If the last digit is even number: use one of the values { High, Low, Medium}
Status:
If the last digit is odd number: use one of the values { Approved, Rejected, Completed }
If the last digit is even number: use one of the values { inProgress, pendingReview }
Category:
If the last digit is odd number: use one of the values { Bug, Enhancement }
If the last digit is even number: use one of the values {Inquiry
}
Now you go to the forked repository in your account and update the repository. This is done using the following command.
git remote add upstream <Master Repository Git URL git fetch upstream
git rebase upstream/master
Update your local clone to the latest in your repository.
Now you will open the file with the first character of your last name. Then you will be adding your GitHub account username in a new line
Example – John Doe will be opening the file d.java and add his GitHub account username which is JSP18SCM78D in a new line.
Now you will do a commit and then push this repository into your GitHub account. While making the commit you are to add your Issue number in the commit message in the following format.
Example – git commit –m “Fixes #<IssueNumber. <GitHub username first name added.”
Say for John Doe the issue he has created is Issue #65. His commit message will be as follows.
git commit –m “Fixes #65. JSP18SCM78D last name added”
10. Once that is done you will create a pull request to the master repository so that your changes can be merged onto the master repository. You will just create the pull request. It will be the TA who will accept your changes. Your pull request title should also be the exact same as your commit message.
This will complete your Phase II. You have to capture the same screenshots mentioned above for phase II and attach it in a document called Report_PhaseII_<GitHubUsername.pdf and submit it.
Deliverable for Phase-II :
Login to your GitHub account and open the repository that you have committed to. Click on the commits Tab.
Click on
You will get the following page. You are to take a screenshot of this page. Click on the commit that you have just made to expand it.
This will expand and show you the individual commit. You have to take a screenshot of this page as well.
The report that you have created will be added to the report folder in the repository and submitted. This means that for the phase I report, you will be adding the report document in that Phase1_Report folder and committing it. And for Phase II you will be adding the report document in the folder Phase2_Report folder and committing it. Make sure that the report for each phase has to be committed and pushed to your repository BEFORE you initiate a pull request.
Phase-III Requirements:
Update and run the modified Python ipynb scripts to do the following:
Requirement #1: Plot in Bar Chart the total number of issues closed every day for every Origination Phase
Requirement #2: Plot in Bar Chart the total number of issues created for every Phase based on their Status
Use ElasticSearch to create an index to store all issues in an index called issues
Create Folium Heatmap to plot all issues retrieved from ElasticSearch on Chicago HeatMap
Create 4 Folium HeatMaps for issues retrieved from ElasticSearch that meet following queries:
DetectionPhase is Field AND Priority is Critical
DetectionPhase is Field AND Status is Completed
DetectionPhase is Field AND Priority is Critical AND Status is Approved
DetectionPhase is Field AND Priority is Critical or High AND Status is Approved or inProgress
Create Folium HeatMap for all locations that got at least 5 issues create for the same location (latitude, Longitude)
Deliverable for Phase-III :
Submit a compressed ZIP file that has all scripts and output files.
Your ipynb scripts must have the following:
Your added code in every cell in the script
Your output below every cell in the script
