corrected typos and wording in READMEs and MAKEMEs

remarcmij · remarcmij · commit d54a80e2e163 · 2018-03-20T16:37:49.000+01:00
diff --git a/Week1/MAKEME.md b/Week1/MAKEME.md
@@ -106,6 +106,11 @@ In the lecture we developed some utility functions to simplify making XMLHttpReq
 - When the user changes the selected repository, any existing repository information in your page should be cleared before displaying the new information.
 - Make your functions small and reusable (modular)! That means create separate functions to handle certain steps.
 
+Note:
+
+1. Please remove all redundant, commented-out code and console.log's from your files before pushing your homework as finished. There is no need for your mentors to review this stuff.
+2. Please make sure your code is well-formatted and follows the recommended naming conventions.
+
 _GO WILD_
 
 Again, check out the GitHub API documentation to see what kind of magic stuff you can do with it.
diff --git a/Week1/README.md b/Week1/README.md
@@ -7,7 +7,7 @@ In week one we will discuss the following topics:
 • API calls
 ```
 
-Here are resources that we like you to read as a preparation for the third lecture:
+Here are resources that we like you to read as a preparation for the first lecture:
 
 ### Fundamentals
 
diff --git a/Week1/lecture/README.md b/Week1/lecture/README.md
@@ -58,7 +58,7 @@ Use the `live-coding` folder for all live coding.
 
 ### 13-xhr-html
 
-- Show that HTML we want to create from the JSON data
+- Show an example of the HTML we want to create dynamically from the JSON data
 
 ### 14-xhr-first
 
diff --git a/Week2/MAKEME.md b/Week2/MAKEME.md
@@ -11,9 +11,9 @@ Topics discussed this week:
 
 - Read this article on scopes & closures: [explaining-javascript-scope-and-closures](https://robertnyman.com/2008/10/09/explaining-javascript-scope-and-closures/)
 
-- If you are still not completely clear on promises, here are some additional nice resources :ring:
+- If you are still not completely clear on promises, here are some additional resources :ring:
 
-    - [Googles post about Promises](https://developers.google.com/web/fundamentals/getting-started/primers/promises)
+    - [Google's post about Promises](https://developers.google.com/web/fundamentals/getting-started/primers/promises)
     - [A nice article from David Walsh](https://davidwalsh.name/promises)
     - [A real life example](https://github.com/mdn/js-examples/blob/master/promises-test/index.html)
     - [stackoverflow](http://stackoverflow.com/questions/13343340/calling-an-asynchronous-function-within-a-for-loop-in-javascript)
@@ -31,10 +31,15 @@ _Deadline Saturday_
 
 The assignment for this week is:
 
-- Complete your GitHub app code as needed to meet the requirements from the assignment of week 1.
+- Complete your GitHub app code from the previous week, if needed, to meet the requirements from that week's assignment.
 - Replace all asynchronous callbacks (e.g. as used with XMLHttpRequest) by ES6 promises.
 - Beautify your app's styling.
 
+Note:
+
+1. Please remove all redundant, commented-out code and console.log's from your files before pushing your homework as finished. There is no need for your mentors to review this stuff.
+2. Please make sure your code is well-formatted and follows the recommended naming conventions.
+
 ## Step 5: Read before next lecture
 
 Go trough the reading material in the [README.md](/Week3/README.md) to prepare for your next class.
diff --git a/Week3/MAKEME.md b/Week3/MAKEME.md
@@ -26,19 +26,19 @@ _Deadline Thursday_
 
 - Fix the issues from the last weeks and make sure you explain how you fixed the issue in a comment (or commit message)
 
-## Step 4: Refactor GitHub app using OOP and ES6 classes
+## Step 4: Refactor the GitHub app using OOP and ES6 classes
 
 - If you need to refresh your memory on es6 classes: [es6-classes-in-depth](https://ponyfoo.com/articles/es6-classes-in-depth)
 
 _Deadline Saturday_
 
-The assignment is to refactor your GitHub to use OOP with ES6 classes (see skeleton code below). We will be introducing a `Repository` and `Contributor` class that will each be responsible for rendering their own data. A third `View` class will contain all remaining code.
+The assignment is to refactor your GitHub app to use OOP with ES6 classes (see skeleton code below). We will be introducing a `Repository` and a `Contributor` class that will each be responsible for rendering their own data. A third `View` class will contain all remaining code.
 
 1. You should refactor your code to use three classes, named `Repository`, `Contributor` and `View`.
 2. Move your existing code that deals with rendering the repository information to the `render()` method of the `Repository` class.
 3. Move your existing code that deals with rendering the information for a single contributor to the `render()` method of the `Contributor` class.
 4. Move your existing code responsible for initializing your application to the `constructor` of the `View` class.
-5. Your remaining code should probably go to the `fetchAndRender()` method of the `View` class.
+5. The bulk of your remaining code should probably go to the `fetchAndRender()` method of the `View` class.
 
 ### Skeleton
 
@@ -134,6 +134,10 @@ Use this skeleton as overall design for your code in `app.js`:
 }
 ```
 
+Note:
+
+1. Please remove all redundant, commented-out code and console.log's from your files before pushing your homework as finished. There is no need for your mentors to review this stuff.
+2. Please make sure your code is well-formatted and follows the recommended naming conventions.
 ## Step 6: Read before next lecture
 
 _Deadline Sunday morning_
