Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Commit 14cb668

Browse files
committed
updated MAKEME's
1 parent 99d49ad commit 14cb668

File tree

4 files changed

+56
-70
lines changed

4 files changed

+56
-70
lines changed

Week1/MAKEME.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Please provide feedback on last week's homework from a fellow student as a GitHu
1919

2020
**_Deadline Thursday_**
2121

22-
_This homework is more extensive and challenging than previous homework! Please read the instructions below carefully and follow them precisely. Start this homework as soon as you can and allow time for discussion and questions (slack!)._
22+
_This homework is more extensive and challenging than previous homework! Please read the instructions below carefully and follow them meticulously. Start this homework as soon as you can and allow time for discussion and questions (slack!)._
2323

2424
### 2.1 Introduction
2525

@@ -54,7 +54,7 @@ If you open this URL in the browser (_try it!_) you will receive JSON data about
5454

5555
<small>Note the query string `?per_page=100` in the above URL. If you don't specify this query string you will only get the first 30 repositories (the default `per_page` is 30). HackYourFuture has more than 30 repositories but less than 100.</small>
5656

57-
The returned JSON data contains some basic information about each repository, such as `name`, `full_name`, `description` etc. There are also many properties that contain URLs to obtain detail information about certain aspects of the repository.
57+
The returned JSON data contains some basic information about each repository, such as `name`, `full_name`, `description` etc. There are also many properties that contain URLs that can be used to obtain detail information about certain aspects of the repository.
5858

5959
#### 2.2.2 Get contributor information for a repository
6060

@@ -73,8 +73,8 @@ You will be working on this same application during the next three weeks. For ea
7373
| Week | Branch | Assignment |
7474
|:----:|--------|------------|
7575
| 1 | `week1` | Create a basic application using callbacks to handle network requests. |
76-
| 2 | `week2` | 1. Refactor the callbacks to promises.<br>2. Make the UI responsive.|
77-
| 3 | `week3` | 1. Refactor the application to use ES6 Classes and async/await.<br>2. Make the app ARIA-compliant. |
76+
| 2 | `week2` | - Refactor the callbacks to promises.<br>- Make the UI responsive.|
77+
| 3 | `week3` | - Refactor the application to use ES6 Classes and async/await.<br>- Make the app ARIA-compliant. |
7878

7979
<small>Table 1. Homework schedule</small>
8080

@@ -190,11 +190,18 @@ It should include the following components:
190190
191191
- Use CSS media queries and [Flexbox](https://css-tricks.com/snippets/css/a-guide-to-flexbox/) to make the UI responsive.
192192
193-
- To force a 404 network error so that you can test the rendering of errors, change the URL to make an invalid GitHub request, e.g. append an `x` to `orgs`: `orgsx`.
193+
- To force a `404` network error so that you can test the rendering of errors, change the URL to make an invalid GitHub request, e.g. append an `x` to `orgs`: `orgsx`.
194194
195195
196196
### 2.5 Handing in your homework
197197
198+
- Have you removed all commented out code (should never be present in a PR)?
199+
- Have you used `const` and `let` and avoided `var`?
200+
- Do the variable, function and argument names you created follow the [Naming Conventions](../../../../fundamentals/blob/master/fundamentals/naming_conventions.md)?
201+
- Is your code well-formatted (see [Code Formatting](../../../../fundamentals/blob/master/fundamentals/naming_conventions.md))?
202+
- Have you resolved all issues flagged by ESLint and the spell checker (no wavy red and green underlines in VSCode)?
203+
204+
If the answer is 'yes' to all preceding questions you are ready to follow these instructions:
198205
199206
1. Push your `week1` branch to GitHub:
200207

Week2/MAKEME.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,11 @@ Topics discussed this week:
2020
- YouTube: [promises](https://www.youtube.com/watch?v=WBupia9oidU)
2121

2222

23-
## Step 2: Feedback
23+
## Step 2: Implement requested PR changes
2424

25-
- Create at least 2 issues (bug / feature / code improvement) on another student's GitHub repository.
26-
- Solve the issue(s) proposed by another students in your GitHub repository. More info [here](https://hackyourfuture.slack.com/files/michahell/F31BX1XT6/Merging_a_local_branch_into_master).
25+
- Fix Requested Changes (if any) on the Pull Request.
2726

28-
## Step 3: Promises
27+
## Step 3: Convert callbacks to promises
2928

3029
**_Deadline Thursday_**
3130

@@ -47,16 +46,17 @@ You will continue to work on the files `index.js` and (possibly) `style.css`.
4746
- Complete your GitHub app code from the previous week, if needed, to meet the requirements from that week's assignment.
4847
- Replace all asynchronous callbacks (e.g. as used with XMLHttpRequest) by ES6 promises.
4948
- Beautify your app's styling.
50-
- Make your app responsive (use CSS media queries and [Flexbox](https://css-tricks.com/snippets/css/a-guide-to-flexbox/)).
51-
- Make your app ARIA-compliant.
49+
- If not yet completed in week 1, make your app responsive (use CSS media queries and [Flexbox](https://css-tricks.com/snippets/css/a-guide-to-flexbox/)).
5250
53-
**ARIA-compliance**
54-
55-
Please review the material from the HTML/CSS module: [Get familiar with Accessible Rich Internet Applications (ARIA)](https://github.com/HackYourFuture/HTML-CSS/tree/master/Week1#get-familiar-with-accessible-rich-internet-applications-aria).
51+
### 3.3 Handing in your homework
5652
57-
For the GitHub application ARIA-compliance means that the Contributors list should either be a native HTML list (i.e. using `ul` and `li` elements) or otherwise marked with an appropriate ARIA **role**. Furthermore, a user should be able to navigate to all interactive elements using the keyboard (e.g., using the **Tab** key). Pressing **Enter** on such an element should be equivalent to a clicking the mouse.
53+
- Have you removed all commented out code (should never be present in a PR)?
54+
- Have you used `const` and `let` and avoided `var`?
55+
- Do the variable, function and argument names you created follow the [Naming Conventions](../../../../fundamentals/blob/master/fundamentals/naming_conventions.md)?
56+
- Is your code well-formatted (see [Code Formatting](../../../../fundamentals/blob/master/fundamentals/naming_conventions.md))?
57+
- Have you resolved all issues flagged by ESLint and the spell checker (no wavy red and green underlines in VSCode)?
5858
59-
### 3.3 Handing in your homework
59+
If the answer is 'yes' to all preceding questions you are ready to follow these instructions:
6060
6161
1. Push your `week2` branch to GitHub:
6262

Week3/MAKEME.md

Lines changed: 33 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,25 @@ Topics discussed this week:
77
• call, apply, bind
88
```
99

10+
1011
## Step 1: Fix requested changes
1112

12-
_Deadline Wednesday_
13+
_Deadline Monday_
1314

14-
- Fix the requested changes from the PR from the last weeks and make sure you explain how you fixed the issue in a comment.
15+
- Fix Requested Changes (if any) on the Pull Request.
1516

1617
## Step 2
1718

19+
**_Deadline Thursday_**
20+
1821
### 2.1 Preparation
1922

23+
**Read the fundamental pages on:**
24+
25+
- [try...catch](../../../../fundamentals/blob/master/fundamentals/try_catch.md)
26+
- [async/await](../../../../fundamentals/blob/master/fundamentals/async_await.md)
27+
28+
2029
The homework for week 3 will build on the work you did in week 2. You will create a new branch based on the `week2` branch.
2130

2231
1. Make sure that you committed all changes in the week 2 version of your homework.
@@ -31,33 +40,29 @@ The homework for week 3 will build on the work you did in week 2. You will creat
3140
This week you will work with all JavaScript files in the `src` folder. The assignment consists of two parts:
3241
3342
1. Refactor all `.then()` and `.catch()` methods with `async`/`await` and `try...catch`.
34-
2. Refactor your application to use ES6 classes.
43+
2. Make your app ARIA-compliant (see below).
44+
3. Refactor your application to use ES6 classes.
45+
3546
3647
#### 2.2.1 async/await
3748
38-
**_Deadline Thursday_**
49+
**Instructions:**
3950
40-
_Read:_
51+
1. Refactor all `.then()` and `.catch()` methods with `async`/`await` and `try...catch`.
4152
42-
- [try...catch](../../../../fundamentals/blob/master/fundamentals/try_catch.md)
43-
- [async/await](../../../../fundamentals/blob/master/fundamentals/async_await.md)
53+
2. Make sure that your error handling code still works. See the week2 MAKEME on how to force an error response from GitHub.
4454
45-
_Instructions:_
4655
47-
- Refactor all `.then()` and `.catch()` methods with `async`/`await` and `try...catch`.
56+
#### 2.2.2 ARIA-compliance
4857
49-
TODO: ARIA-compliance
58+
Please review the material from the HTML/CSS module: [Get familiar with Accessible Rich Internet Applications (ARIA)](https://github.com/HackYourFuture/HTML-CSS/tree/master/Week1#get-familiar-with-accessible-rich-internet-applications-aria).
5059
51-
#### 2.2.2 Bonus assignment: ES6 Classes
60+
For the GitHub application ARIA-compliance means that the Contributors list should either be a native HTML list (i.e. using `ul` and `li` elements) or otherwise marked with an appropriate ARIA **role**. Furthermore, a user should be able to navigate through all interactive elements using the keyboard (e.g., using the **Tab** key). Pressing **Enter** on such an element should be equivalent to clicking the mouse.
5261
53-
**_Deadline Saturday_**
62+
#### 2.2.3 ES6 Classes (Bonus)
5463
5564
This final **bonus** assignment requires you to got the extra mile and master Object Oriented Programming and ES6 classes. ES6 classes are not used in the Node and Database modules. You will not come across them again until the React module.
5665
57-
TODO: Is this optional/bonus? Separate branch `final`?
58-
59-
**_Deadline Thursday_**
60-
6166
In this assignment you need to redistribute and adapt the code from `index.js` to the files `App.js`, `Repository.js` and `Contributor.js`. You do not need to modify `Util.js`.
6267
6368
| File | Description |
@@ -76,8 +81,7 @@ _Read:_
7681
7782
_Instructions:_
7883
79-
1. Commit any outstanding changes.
80-
2. Change the content of the `body` tag of `index.html` as follows:
84+
1. Copy `index.html` to file named `classes.html` and change the content of the `body` tag of `classes.html` as follows:
8185
8286
```html
8387
<body>
@@ -90,45 +94,25 @@ _Instructions:_
9094
```
9195
9296
93-
## Step 3: OOP and ES6 classes
94-
95-
- If you need to refresh your memory on es6 classes: [es6-classes-in-depth](https://ponyfoo.com/articles/es6-classes-in-depth)
96-
97-
_Deadline Saturday_
98-
99-
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.
97+
#### 2.2.4 Handing in your homework
10098
101-
Read:
99+
- Have you removed all commented out code (should never be present in a PR)?
100+
- Have you used `const` and `let` and avoided `var`?
101+
- Do the variable, function and argument names you created follow the [Naming Conventions](../../../../fundamentals/blob/master/fundamentals/naming_conventions.md)?
102+
- Is your code well-formatted (see [Code Formatting](../../../../fundamentals/blob/master/fundamentals/naming_conventions.md))?
103+
- Have you resolved all issues flagged by ESLint and the spell checker (no wavy red and green underlines in VSCode)?
102104
103-
- [Object Oriented Programming and ES6 Classes](../../../../fundamentals/blob/master/fundamentals/oop_classes.md)
104-
- [The `this` keyword](../../../../fundamentals/blob/master/fundamentals/this.md)
105+
If the answer is 'yes' to all preceding questions you are ready to follow these instructions:
105106
106-
Instructions:
107-
108-
1. You should refactor your code into four classes, named `App`, `Repository`, `Contributor` and `Util`.
109-
2. Move your existing code that deals with rendering the repository information to the `render()` method of the `Repository` class.
110-
3. Move your existing code that deals with rendering the information for a single contributor to the `render()` method of the `Contributor` class.
111-
4. Move your existing code responsible for initializing your application to the `constructor` of the `View` class.
112-
5. The bulk of your remaining code should probably go to the `fetchAndRender()` method of the `View` class.
113-
114-
TODO: describe the division of work between the classes
115-
116-
117-
### 3.3 Handing in your homework
118-
119-
1. Push your `week2` branch to GitHub:
107+
1. Push your `week3` branch to GitHub:
120108
121109
```
122-
git push -u origin week2
110+
git push -u origin week3
123111
```
124112
125-
2. Create a pull request for your `week2` branch.
126-
127-
Note:
113+
2. Create a pull request for your `week3` branch.
128114
129-
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.
130-
2. Please make sure your code is well-formatted and follows the recommended naming conventions.
131-
## Step 6: Read before next lecture
115+
## Step 3: Read before next lecture
132116
133117
_Deadline Sunday morning_
134118

termp.html

Lines changed: 0 additions & 5 deletions
This file was deleted.

0 commit comments

Comments
 (0)