forked from walice/git-tutorial
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathslides.html
More file actions
689 lines (452 loc) · 18.1 KB
/
slides.html
File metadata and controls
689 lines (452 loc) · 18.1 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
<!DOCTYPE html>
<html lang="" xml:lang="">
<head>
<title>GitHub Tutorial</title>
<meta charset="utf-8" />
<meta name="author" content="Alice Lépissier" />
<meta name="date" content="2020-08-28" />
<script src="https://use.fontawesome.com/5235085b15.js"></script>
<link rel="icon" href="assets/favicon.ico" type="image/x-icon">
<link rel="stylesheet" href="xaringan-themer.css" type="text/css" />
<link rel="stylesheet" href="custom.css" type="text/css" />
</head>
<body>
<textarea id="source">
class: title-slide-custom, title-slide, middle
background-color: #557571
<div>
<img class="circle" style="position: absolute; top: 50px;right: 50px;" src="https://octodex.github.com/images/nyantocat.gif" width="150px">
</div>
# GitHub Tutorial
### 5 MINUTE GIT
<br><br>
.h4[Alice Lépissier]
.h4[<a href="https://github.com/walice/git-tutorial"><i class="fa fa-github fa-fw"></i>&nbsp; https://github.com/walice/git-tutorial</a>]
<br><br>
.h4[28 August 2020]
---
# Do you dread using Git?
<div>
<video width="100%" height="90%" controls muted>
<source src="assets/back-to-skool.mp4" type="video/mp4">
</video>
</div>
---
# This tutorial is for you
<br>
.pull-left[
.h4[If you want to get started with Git **now**.]
Here, we will focus on the tools you _actually_ need to start working collaboratively and putting your work under version control.
Git is extremely powerful and there are myriad sophisticated things you can do with it. As a result, the [<svg style="height:0.8em;top:.04em;position:relative;fill:#d49a89;" viewBox="0 0 448 512"><path d="M448 360V24c0-13.3-10.7-24-24-24H96C43 0 0 43 0 96v320c0 53 43 96 96 96h328c13.3 0 24-10.7 24-24v-16c0-7.5-3.5-14.3-8.9-18.7-4.2-15.4-4.2-59.3 0-74.7 5.4-4.3 8.9-11.1 8.9-18.6zM128 134c0-3.3 2.7-6 6-6h212c3.3 0 6 2.7 6 6v20c0 3.3-2.7 6-6 6H134c-3.3 0-6-2.7-6-6v-20zm0 64c0-3.3 2.7-6 6-6h212c3.3 0 6 2.7 6 6v20c0 3.3-2.7 6-6 6H134c-3.3 0-6-2.7-6-6v-20zm253.4 250H96c-17.7 0-32-14.3-32-32 0-17.6 14.4-32 32-32h285.4c-1.9 17.1-1.9 46.9 0 64z"/></svg> documentation](https://git-scm.com/book/en/v2) is very thorough, but can often be overwhelming 🤯 if you are just starting.
]
.pull-right[
<img src="https://octodex.github.com/images/Professortocat_v2.png">
]
---
# Why you should use Git
.h4[To be kind to yourself]
.h4[To be kind to your collaborators]
.h4[To ensure your work is reproducible]
<br>
--
### Spillover benefits
👩🔬 📐 It imposes a certain discipline to your programming.
🤓 🔥 You can be braver when you code: if your new feature breaks, you can revert back to a version that worked!
---
# Demystifying Git
**Git** is the software that allows us to do version control.
**GitHub Desktop** provides a user-friendly interface to use Git.
You can host **remote** repositories on https://github.com/. You edit and work on your content in your **local** repository on your computer, and then you send your changes to the remote.
You can interact with Git using the **Graphical User Interface (GUI)** provided by GitHub Desktop, or through the **Command Line Interface (CLI)**.
.h4[You can accomplish the essential steps using the GUI.]
.h4[Hence "5 minute Git".]
Once you start doing more complex operations, you will need the CLI.
---
background-image: url(assets/remote-local.png)
background-size: contain
---
# Installation (GUI)
Install GitHub Desktop from <https://desktop.github.com/>.
<div style="width: 100%;">
<img src="https://repository-images.githubusercontent.com/58559694/aeae5400-6102-11e9-980d-dc74185ed41d" width="100%">
</div>
---
# Installation (CLI)
<br><br>
.pull-left[
<br>
GitHub Desktop allows you to use Git through the Windows command prompt.
But we are going to install **Git Bash** which is a more useful shell.
Intall Git Bash from https://gitforwindows.org/.
]
.pull-right[
<div class="card">
<img src="https://gitforwindows.org/img/gwindows_logo.png" alt="Card Back">
<img src="https://gitforwindows.org/img/git_logo.png" class="img-top" alt="Card Front">
</div>
]
---
class: inverse, middle, center
# Using GitHub Desktop
### (5 minute Git)
---
# The basic workflow
### First time
1. **Clone** the repository that you want to work on from GitHub onto your local machine
2. Work on the files/scripts, e.g., `penguins.R`
3. Next, you will **commit** your changes and include an informative message, e.g. "Plot distribution of flipper length"
4. Then, you will **push** your changes to the remote repository
### Subsequent times
1. **Pull** any changes from the remote repository that your collaborators might have made
2. Repeat steps 2-4 above
---
# Cloning
<div>
<video width="100%" height="90%" controls muted>
<source src="assets/cloning.mp4" type="video/mp4">
</video>
</div>
---
# Exercise script in this repo
The repo [walice/git-tutorial](https://github.com/walice/git-tutorial) contains the `penguins.R` script, which works with data from the `palmerpenguins` library.
<div class="figure" style="text-align: center">
<img src="assets/meet-the-penguins.png" alt="Artwork by @allison_horst." width="80%" />
<p class="caption">Artwork by @allison_horst.</p>
</div>
---
# Work on the files
```r
ggplot(penguins,
aes(x = bill_length_mm, y = bill_depth_mm, color = species)) +
geom_point() +
labs(title = "Penguin bills")
```
<img src="slides_files/figure-html/unnamed-chunk-3-1.png" style="display: block; margin: auto;" />
---
# Staging your files
---
# Commit your changes
<div>
<video width="100%" height="90%" controls muted>
<source src="assets/committing.mp4" type="video/mp4">
</video>
</div>
---
# Commit your changes
.h4[Use an informative commit message]
- (Not great) "Analyze data" 😞
- (Better) "Estimate logistic regression" 🎉
.h4[Have a consistent style]
- Start with an action verb
- Capitalize message
.h4[Commits are _cheap_, use them often!]
---
# Push your changes
<div>
<video width="100%" height="90%" controls muted>
<source src="assets/pushing.mp4" type="video/mp4">
</video>
</div>
---
class: inverse, middle, center
# Using the command line
### (5 minute Git)
---
# 5 minute Git
.h4[Clone the repo]
```bash
git clone https://github.com/walice/git-tutorial.git
```
.h4[Work on `penguins.R`]
.h4[Stage your files]
```bash
git add .
```
.h4[Commit your changes]
```bash
git commit -m "Add example code"
```
.h4[Push your changes]
```bash
git push
```
---
class: inverse, middle, center
# More command line tips
---
# Tell Git who you are
.h4[As a first-time set up, you need to tell Git who you are.]
```bash
git config --global user.name "Your name"
git config --global user.email "[email protected]"
```
---
# git status
.h4[Use this to check at what stage of the workflow you are at.]
_This happens when you have modified the script, but haven't staged your changes yet._
```bash
git status
```
```bash
*Changes not staged for commit:
(use "git add <file>..." to update what will be committed)
(use "git checkout -- <file>..." to discard changes in working directory)
* modified: penguins.R
no changes added to commit (use "git add" and/or "git commit -a")
```
---
# git status
_After you stage the `penguins.R` file, but before you commit the changes._
```bash
git add penguins.R
git status
```
```bash
*Changes to be committed:
(use "git reset HEAD <file>..." to unstage)
modified: penguins.R
```
.h4[When your local repository is in sync with the remote.]
```bash
git status
```
```bash
On branch master
Your branch is up to date with 'origin/master'.
*nothing to commit, working tree clean
```
---
# git pull
Your collaborators have been adding some awesome content to the repository, and you want to fetch their changes from the remote and update your local repository.
.h4[Use this to fetch changes from the remote and to merge them in to your local repository.]
```bash
git pull
```
What this is doing under-the-hood is running a `git fetch` and then `git merge`.
---
# Adding and ignoring files
To stage specific files in your repository, you can name them directly
```bash
git add penguins.R other-script.R
```
or you can add all of them at once
```bash
git add .
```
You might want to _not_ track certain files in your local repository, e.g., sensitive files such as credentials. But it might get tedious to type out each file that you _do_ want to include by name.
.h4[Use a .gitignore file to specify files to always ignore.]
Create a file called `.gitignore` and place it in your repo. The content of the file should include the names of the files that you want Git to **not track**.
---
# git log
.h4[Use this to look at the history of your repository.]
Each commit has a specific **hash** that identifies it.
```bash
git log
```
```bash
*commit af58f79bfa4301643025dd6c8767e65349cf407a
Author: Name <Email address>
Date: DD-MM-YYYY
Add penguin script
```
You can also find this on GitHub, by going to [github.com/user-name/repo-name/commits](https://github.com/walice/git-tutorial/commits).
.h4[You can go back in time to a specific commit, if you know its reference.]
---
# Undoing mistakes
Imagine you did some work, **committed** the changes, and **pushed** them to the remote repo. But you'd like to undo those changes.
.h4[Running `git revert` is a "soft undo".]
Say you added some plain text by mistake to `penguins.R`. Running `git revert` will do the opposite of what you just did (i.e., remove the plain text) and create a new commit. You can then `git push` this to the remote.
```bash
git revert <hash-of-the-commit-you-want-to-undo>
git push
```
---
# Undoing mistakes
`git revert` is the safest option to use.
.h4[It will preserve the history of your commits.]
```bash
git log
```
```bash
commit 6634a076212fb7bac16f9525feae1e83e0f200ca
Author: Name <Email address>
Date: DD-MM-YYYY
* Revert "Add plain text to code by mistake"
* This reverts commit a8cf7c2592273ef6a28920222a92847794275868.
commit a8cf7c2592273ef6a28920222a92847794275868
Author: Name <Email address>
Date: DD-MM-YYYY
Add plain text to code by mistake
```
---
# Rewriting history
You can **change the contents of the repo** to look like it did at a _specific point in time_, by specifying the reference of the commit you want to go back to.
For example, we can rewind history to before we added the plain text by mistake and had to revert it, using `git reset` to the point just before that. This will delete the history of any commits that happened after that point.
.h4[This will rewrite history. This is (generally) bad.]
After you `git reset`, you need to **force** your changes on the repo (this is what the `-f` flag means).
```bash
git reset --hard <hash-of-the-commit-you-want-to-go-back-to>
git push -f
```
---
class: inverse, middle, center
# Other resources
---
# Other Git resources
### http://swcarpentry.github.io/git-novice/
### https://github.github.com/training-kit/downloads/github-git-cheat-sheet/
### https://learngitbranching.js.org/
<!-- ### https://happygitwithr.com/ -->
<!-- ### https://ndpsoftware.com/git-cheatsheet.html -->
---
class: middle, center
background-color: #557571
## .white[Links]
.h4[<svg style="height:0.8em;top:.04em;position:relative;fill:#d49a89;" viewBox="0 0 576 512"><path d="M542.22 32.05c-54.8 3.11-163.72 14.43-230.96 55.59-4.64 2.84-7.27 7.89-7.27 13.17v363.87c0 11.55 12.63 18.85 23.28 13.49 69.18-34.82 169.23-44.32 218.7-46.92 16.89-.89 30.02-14.43 30.02-30.66V62.75c.01-17.71-15.35-31.74-33.77-30.7zM264.73 87.64C197.5 46.48 88.58 35.17 33.78 32.05 15.36 31.01 0 45.04 0 62.75V400.6c0 16.24 13.13 29.78 30.02 30.66 49.49 2.6 149.59 12.11 218.77 46.95 10.62 5.35 23.21-1.94 23.21-13.46V100.63c0-5.29-2.62-10.14-7.27-12.99z"/></svg><a href="https://alicelepissier.com/git-tutorial/slides.html">.accent[&nbsp; Slides]</a>]<br>
.h4[.accent[<i class="fa fa-github fa-fw"></i>]<a href="https://github.com/walice/git-tutorial">.accent[&nbsp; walice/git-tutorial]</a>]<br>
.h4[.accent[<i class="fa fa-envelope"></i>]<a href="mailto:[email protected]">.accent[&nbsp;&nbsp;[email protected]]</a>]
<br>
## .white[Dataset reference]
<div style="display:flex; align-items:center;">
<img src="https://allisonhorst.github.io/palmerpenguins/reference/figures/palmerpenguins.png" width="15%"/><span>.white[Horst AM, Hill AP, Gorman KB (2020). palmerpenguins: Palmer Archipelago (Antarctica) penguin data. R package version 0.1.0.]<br><a href="https://allisonhorst.github.io/palmerpenguins/" style="color:#d49a89;">https://allisonhorst.github.io/palmerpenguins/</a><br>.white[doi: 10.5281/zenodo.3960218]</span>
</div>
</textarea>
<style data-target="print-only">@media screen {.remark-slide-container{display:block;}.remark-slide-scaler{box-shadow:none;}}</style>
<script src="https://remarkjs.com/downloads/remark-latest.min.js"></script>
<script>var slideshow = remark.create({
"highlightStyle": "github",
"highlightLines": true,
"countIncrementalSlides": false
});
if (window.HTMLWidgets) slideshow.on('afterShowSlide', function (slide) {
window.dispatchEvent(new Event('resize'));
});
(function(d) {
var s = d.createElement("style"), r = d.querySelector(".remark-slide-scaler");
if (!r) return;
s.type = "text/css"; s.innerHTML = "@page {size: " + r.style.width + " " + r.style.height +"; }";
d.head.appendChild(s);
})(document);
(function(d) {
var el = d.getElementsByClassName("remark-slides-area");
if (!el) return;
var slide, slides = slideshow.getSlides(), els = el[0].children;
for (var i = 1; i < slides.length; i++) {
slide = slides[i];
if (slide.properties.continued === "true" || slide.properties.count === "false") {
els[i - 1].className += ' has-continuation';
}
}
var s = d.createElement("style");
s.type = "text/css"; s.innerHTML = "@media print { .has-continuation { display: none; } }";
d.head.appendChild(s);
})(document);
// delete the temporary CSS (for displaying all slides initially) when the user
// starts to view slides
(function() {
var deleted = false;
slideshow.on('beforeShowSlide', function(slide) {
if (deleted) return;
var sheets = document.styleSheets, node;
for (var i = 0; i < sheets.length; i++) {
node = sheets[i].ownerNode;
if (node.dataset["target"] !== "print-only") continue;
node.parentNode.removeChild(node);
}
deleted = true;
});
})();
(function() {
"use strict"
// Replace <script> tags in slides area to make them executable
var scripts = document.querySelectorAll(
'.remark-slides-area .remark-slide-container script'
);
if (!scripts.length) return;
for (var i = 0; i < scripts.length; i++) {
var s = document.createElement('script');
var code = document.createTextNode(scripts[i].textContent);
s.appendChild(code);
var scriptAttrs = scripts[i].attributes;
for (var j = 0; j < scriptAttrs.length; j++) {
s.setAttribute(scriptAttrs[j].name, scriptAttrs[j].value);
}
scripts[i].parentElement.replaceChild(s, scripts[i]);
}
})();
(function() {
var links = document.getElementsByTagName('a');
for (var i = 0; i < links.length; i++) {
if (/^(https?:)?\/\//.test(links[i].getAttribute('href'))) {
links[i].target = '_blank';
}
}
})();
// adds .remark-code-has-line-highlighted class to <pre> parent elements
// of code chunks containing highlighted lines with class .remark-code-line-highlighted
(function(d) {
const hlines = d.querySelectorAll('.remark-code-line-highlighted');
const preParents = [];
const findPreParent = function(line, p = 0) {
if (p > 1) return null; // traverse up no further than grandparent
const el = line.parentElement;
return el.tagName === "PRE" ? el : findPreParent(el, ++p);
};
for (let line of hlines) {
let pre = findPreParent(line);
if (pre && !preParents.includes(pre)) preParents.push(pre);
}
preParents.forEach(p => p.classList.add("remark-code-has-line-highlighted"));
})(document);</script>
<script type='text/javascript'>
var slideElements
function getElementForSlide(slide) {
slideElements = slideElements || document.querySelectorAll('.remark-slide')
return slideElements[slide.getSlideIndex()]
}
slideshow.on('showSlide', function (slide) {
Array.from(getElementForSlide(slide).querySelectorAll('video, audio')).forEach(function (vid) {
vid.loop = false
vid.currentTime = 0
vid.play()
})
})
slideshow.on('hideSlide', function (slide) {
Array.from(getElementForSlide(slide).querySelectorAll('video, audio')).forEach(function (vid) {
vid.pause()
})
})
</script>
<script>
slideshow._releaseMath = function(el) {
var i, text, code, codes = el.getElementsByTagName('code');
for (i = 0; i < codes.length;) {
code = codes[i];
if (code.parentNode.tagName !== 'PRE' && code.childElementCount === 0) {
text = code.textContent;
if (/^\\\((.|\s)+\\\)$/.test(text) || /^\\\[(.|\s)+\\\]$/.test(text) ||
/^\$\$(.|\s)+\$\$$/.test(text) ||
/^\\begin\{([^}]+)\}(.|\s)+\\end\{[^}]+\}$/.test(text)) {
code.outerHTML = code.innerHTML; // remove <code></code>
continue;
}
}
i++;
}
};
slideshow._releaseMath(document);
</script>
<!-- dynamically load mathjax for compatibility with self-contained -->
<script>
(function () {
var script = document.createElement('script');
script.type = 'text/javascript';
script.src = 'https://mathjax.rstudio.com/latest/MathJax.js?config=TeX-MML-AM_CHTML';
if (location.protocol !== 'file:' && /^https?:/.test(script.src))
script.src = script.src.replace(/^https?:/, '');
document.getElementsByTagName('head')[0].appendChild(script);
})();
</script>
</body>
</html>