Merge branch 'master' into task-demo-screenshots

Author: kabaros

README.md

@@ -1,7 +1,7 @@
 # My Resume
 
 1. Fork and Clone this repo
-2. run `npm install` then `npm start` (don't worry if you don't understand these commands now, we will explain them in Node module)
+2. Run `npm install` then `npm start` (don't worry if you don't understand these commands now, we will explain them in Node module)
 3. When you run `npm start`, your browser should open the webpage immediately with hot reload enabled (i.e. when you change files, they will automatically be reflected on the page).
 
 ## Github API
@@ -10,11 +10,12 @@ Github provides an **API** that provides a way for developers to retrieve inform
 
 The documentation for the `repos` endpoint is available on: [https://developer.github.com/v3/repos/](https://developer.github.com/v3/repos/)
 
-- Try to open this URI on the browser https://api.github.com/users/codeyourfuture/repos. What do you get back? Try changing *codeyourfuture* to your Github username, and see if you get back your list of repositories.
+- Try to open this URI on the browser [https://api.github.com/users/codeyourfuture/repos](https://api.github.com/users/codeyourfuture/repos). What do you get back? Try changing *codeyourfuture* to your Github username, and see if you get back your list of repositories.
 
 **Now to the requirements.**
 
 ## Part 1: My Github Page
+
 ### Requirement 1: Show my Repos
 **Given** I am on the Resume site  
 **When** I click on `My Github` link  
@@ -30,7 +31,7 @@ The documentation for the `repos` endpoint is available on: [https://developer.g
 **When** I click on `My Github` link  
 **Then** I should be shown the number of repos in my Github account (in place of the `X`)
 
-> The page `my-github.html` under the folder *pages* has a reference to the script `my-github.js` and the CSS file `my-github.css`. These are the files that you will need to change for these tasks.
+For the above requirements, you need to use the API:
 
 ![tasks 1-3 demo](./homework_assets/tasks1-3demo.png)
 
@@ -40,44 +41,67 @@ GET [https://api.github.com/repos/codeyourfuture/js-exercises/pulls](https://api
 
 For the below 3 tasks, you'll need to work in: `pull-requests.html` & `pull-requests.js`
 
+> GET https://api.github.com/users/*YOUR GITHUB USERNAME*/repos
+
+Where do I write the code for Part 1 requirements?
+
+> Under the folder *pages* there is the HTML page `my-github.html`. Inside this file there are references to the script `my-github.js` and the CSS file `my-github.css`. These are the files that you will need to change for Part 1 tasks.
 
 ### Requirement 4: Show ALL Pull Requests
 **Given** I am on the Resume site  
-**When** I click on `My Pull Requests` page  
+**When** I click on `Pull Requests` link  
 **Then** I should be shown a list of all *Pull Requests title* as a link  
-**AND** the link should take me to the Pull Request on Github (use `html_url` property)
+**AND** the link should take me to the Pull Request on Github (use `html_url` property from the API response)
 
 ### Requirement 5: Show Only My Pull Requests
 
-Update the previous requirement to only show your Pull Requests. Look at the `JSON` response and think how you can _filter_ the response
+Update the code your wrote for the previous requirement to only show your own Pull Requests. Look at the `JSON` response and think how you can _filter_ the response.
 
 ### Requirement 6: Search for my friend's Pull Requests
 
-Update the previous page to add a `Search input`. This allows the user  to enter a Github user, and while they are searching, we should _filter_ the displayed list of Pull  Requests to only show that user's Pull Requests.
+Add a `Search input` on the `My Pull Requests` page. This allows the user to enter a Github username, and while they are searching, we should _filter_ the displayed list of Pull Requests to only show that user's Pull Requests.
 
 **Given** I am on the the Pull Requests page  
 **When** I enter a *github user* in the *search box*  
 **Then** I should be shown a list of *Pull Requests title* for that User only  
 
 ![task 6 demo](./homework_assets/task6demo.png)
 
+For the above requirements, you need to use the API:
+
+> GET [https://api.github.com/repos/codeyourfuture/js-exercises/pulls](https://api.github.com/repos/codeyourfuture/js-exercises/pulls)
+
+> hint: This request lists all the pull requests against js-exercises. How can you show only the ones that related to your Github username (How can you _filter_ the list).
+
+Where do I write the code for Part 2 requirements?
+
+> The file `pull-requests.js` is where you need to write the JavaScript to peform these requirements.
+
 ## Part 3: Update My Github Page to show other Github user's repos
 
 ### Requirement 7: Display someone else's repos in My Github
 
-Update the **My Github** page to add a `Search input` and a `Search button`. This allows the user  to enter a Github user, and when they click **Search** then the page should display The  Pull Requests for that user.
+Update the **My Github** page to add a `Search input` and a `Search button`. This allows the user to enter a Github username, and when they click **Search** then the page should display the Pull Requests for that user.
 
 **Given** I am on *My Github* page  
-**When** I enter a *github user* in the *search box*  
+**When** I enter a *github username* in the *search box*  
 **And** I click Enter  
-**Then** I should be shown a list of the  repos for that User  
+**Then** I should be shown a list of the repos for that user  
 
 (stretch goal: if the search box is empty then it should default to my User)
 
 > You will need to update the code in `my-github.js` to finish this final task.
 
 ![task 7 demo](./homework_assets/task7demo.png)
 
+For the above requirements, you need to use the API:
+
+> GET https://api.github.com/users/*A GITHUB USERNAME*/repos
+
+Where do I write the code for Part 3 requirements?
+
+> You will need to update the code in `my-github.js` to finish these tasks.
+
 ## Bonus Task: Random API
 Pick any random API from https://github.com/toddmotto/public-apis (**only those that don't require authentication (have Auth No)**) and create a page to use the API