Skip to content

Commit d6f9f43

Browse files
authored
Merge pull request HackYourFuture#4 from vincentsels/update-forks
Clarified forks, branches & pull requests
2 parents c928d8d + b9d1afc commit d6f9f43

2 files changed

Lines changed: 47 additions & 20 deletions

File tree

‎Week1/MAKEME.md‎

Lines changed: 47 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -72,30 +72,51 @@ You will be working on the same application during the next three weeks. For eac
7272
## Part 1 - <small>Set-up your environment</small>
7373
**Deadline: Wednesday evening**
7474

75-
- [ ] Fork our class' fork of the JavaScript3 repository to your own GitHub account. Yes, you'll be creating a fork of a fork of a fork:
75+
- [ ] [Fork](https://help.github.com/en/articles/fork-a-repo) our class' fork of the JavaScript3 repository to your own GitHub account. Yes, you'll be creating a fork of a fork of a fork:
7676

77-
```
78-
- Main HYF Javascript 3 repository: https://github.com/HackYourFuture/JavaScript3
79-
- Belgium HYF fork: https://github.com/HackYourFutureBelgium/JavaScript3
80-
- Our class' (Rob's) fork: https://github.com/segersrobbert/JavaScript3
81-
- Your fork here.
82-
```
77+
```
78+
- Main HYF Javascript 3 repository: https://github.com/HackYourFuture/JavaScript3
79+
- Belgium HYF fork: https://github.com/HackYourFutureBelgium/JavaScript3
80+
- Our class' (Rob's) fork: https://github.com/segersrobbert/JavaScript3
81+
- Your fork here.
82+
```
8383

84-
- [ ] Clone the fork to your laptop.
84+
> *Reminder*: A fork is like your own copy of a repository, under your own account, of someone else's repository. Read everything about forking and being social on GitHub [here](https://help.github.com/en/articles/fork-a-repo).
85+
>
86+
> We use forks so that you can later on create [Pull Requests](https://help.github.com/en/articles/about-pull-requests). In short, a pull request (PR) is a way to ask the original owner of a repository (where you forked off from) to merge a change that you did on a branch of your local repository, into the original repository.
87+
>
88+
> A big advantage of PR's is that it allows to **compare code** and **give feedback** directly on the code! This is very handy when reviewing homework!
89+
90+
- [ ] [Clone](https://help.github.com/en/articles/fork-a-repo#step-2-create-a-local-clone-of-your-fork) the fork to your laptop.
8591

8692
- [ ] Open the newly created `JavaScript3` folder from the cloned repository in VS Code *(always open this entire main folder!)*
93+
94+
> *Tip*: a command line, you can open a folder in VS Code by typing:
95+
>
96+
> ```
97+
> code .
98+
> ```
99+
100+
- [ ] Open a Terminal window in VS Code or in your favorite terminal (like [cmder](https://cmder.net/) or [mingw32](https://gitforwindows.org/)), and **from the main `JavaScript3` folder**, type the following command to install the airbnb style guide and ESLint tools as required for the homework:
101+
102+
```
103+
npm install
104+
```
105+
106+
This should output something like this. If not, contact your coach on Slack!
87107
88-
- [ ] Open a Terminal window in VS Code or elsewhere, and **from the main JavaScript3 folder**, type the following command to install the airbnb style guide and ESLint tools as required for the homework:
108+
```
109+
$ npm install
110+
npm WARN hyf-js3-homework@1.0.0 No repository field.
89111

90-
```
91-
npm install
92-
```
112+
added 188 packages in 19.38s
113+
```
93114
94115
- [ ] Create a new branch for the week 1 homework with the following command:
95116
96-
```
97-
git checkout -b week1
98-
```
117+
```
118+
git checkout -b week1
119+
```
99120
100121
- [ ] Install the [**ESLint**](https://eslint.org/) extension in VS Code. This extension will highlight and inform you of any violations of the style guide, and allow you to auto-fix a lot of issues. You should probably also already install the [**EditorConfig for VS Code**](https://editorconfig.org/) plugin. Although it's not required in our case because we all use the same editor, it will come in handy when you work on public projects in the future.
101122
@@ -168,12 +189,18 @@ If the answer is 'yes' to the preceding questions you are ready to follow these
168189
169190
- [ ] Push your `week1` branch to GitHub:
170191
171-
```
172-
git push -u origin week1
173-
```
192+
```
193+
git push -u origin week1
194+
```
195+
196+
This will give you a link that you can follow to immediately create a pull request (see next step).
174197
175198
- [ ] Create a pull request (PR) for your `week1` branch against our class' (Rob's) fork `master` branch.
176199
177-
- [ ] Keep an eye on your notifications: if there are issues with your homework, we'll add comments to your PR. If we don't add comments, that means you've done an excellent job - or we dind't find the time to review it :(.
200+
![Create PR in GitHub](./assets/create_pr.png)
201+
202+
- [ ] Keep an eye on your notifications: if there are issues with your homework, your coach will add comments to your PR. If they don't add comments, that means you've done an excellent job - or they dind't find the time to review it :(.
203+
204+
Note that of course the coach will never actually *merge* your PR.
178205
179-
- [ ] You can always amend your homework by pushing more commits to your branch - they'll be included in the pull request. Do this to resolve any remarks we gave in the comments!
206+
- [ ] You can always amend your homework by pushing more commits to your branch - they'll be included in the pull request automatically, and your coach will be notified. Do this to resolve any remarks your coach gave in the comments!

‎Week1/assets/create_pr.png‎

43.3 KB
Loading

0 commit comments

Comments
 (0)