forked from ionides/810f21
-
Notifications
You must be signed in to change notification settings - Fork 0
/
hw09.Rmd
167 lines (92 loc) · 6.71 KB
/
hw09.Rmd
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
---
title: "STATS 810 Fall 2021, Homework 9. <br>Internet repositories for collaboration and open-source research: git and GitHub"
output:
html_document:
theme: flatly
toc: no
---
## Objectives
* Git has become central to collaborative computing, sharing of data and code, and open source software. A professional statistician should have at least a working knowledge of git. Git is slowly becoming incorporated into more undergraduate and graduate courses, but likely this class spans a wide range from git novices to experts. If this assignment is trivial for you, consider helping others who are new to git.
* GitHub is the largest git-based internet repository, but others (such as Bitbucket) also use git. You can use git to build a local repository on your own computer, though in practice it is usually convenient to have the repository linked to an internet site.
* Our tasks are
i. Learn some ways to think about what a git repository is and how it works.
ii. Follow the instructions below to practice going through the process of editing a GitHub repository, making a fork, and submitting a pull request.
iii. Use the self-teaching materials at [GitHub Learning Lab](https://lab.github.com/) or [Atlassian](https://www.atlassian.com/git/tutorials) to spend an hour or so advancing your knowledge of git. The Atlassian tutorials are better for learning command-line git, but they teach in the context of Bitbucket which is currently less popular than GitHub although both are based around the same git program. The [Introduction to GitHub module](https://lab.github.com/githubtraining/introduction-to-github) may be a good starting point for beginners. Alternatively, browse Karl Broman's practical and minimal [git/github tutorial](http://kbroman.org/github_tutorial/) which this assignment draws on.
iv. Report briefly on your past experience with git, and what you learned while studying for this homework. Edit the `hw09.Rmd` file in the `810f21` git repository, compile this to html (for example, using Rstudio) and submit your report via Canvas as an html file.
YOUR ANSWER HERE. YOU CAN DELETE THE REMAINDER OF THIS FILE IF YOU WANT TO.
--------------
--------------
## Getting started with git and GitHub
1. Get an account on GitHub, if you do not already have one.
2. If git is not installed already, download and install it from [git-scm.com/downloads](http://git-scm.com/downloads).
3. Set up your local git installation with your user name and email. Open a terminal and type:
```
$ git config --global user.name "Your name here"
$ git config --global user.email "[email protected]"
```
Don’t type the \$; that just indicates that you’re doing this at the command line. On Windows, you can run these commands in the Linux emulator provided by the git client. Disclaimer: I do not run a Windows machine, so please let me know if Windows instructions are incorrect or out-of-date.
4. Optional but recommended: set up secure password-less SSH communication to GitHub, following the [GitHub instructions](https://help.github.com/articles/generating-ssh-keys/).
------------------
-----------------
## Basic git concepts
* **repository**. A representation of the current state of a collection of files, and its entire history of modifications.
* **commit**. A commit is a change to one or many of the files in repository. The repository therefore consists of a directed graph of all previous commits.
* **branch**. Multiple versions of the collection of files can exist simultaneously in the repository.
These versions are called branches.
Branches may represent new functionality, or a bug fix, or different versions of the code with slightly different goals.
+ Branches have names. A special name called **master** is reserved for the main development branch.
+ Branches can be **created**, **deleted** or **merged**.
+ Each new commit is assigned to a branch.
* We now have the pieces in place to visualize the **graph** of a git repository. <small>[Picture credit: [hades.github.io](http://hades.github.io/media/git/git-history.png)]</small>
<br>
* Take some time to identify the commits, branching events, and merging events on the graph.
+ Note that branch names actually are names for the most recent commit on that branch, known as the **head** of the branch.
-----------------
----------------
## An elementary task: cloning a remote repository
* In a suitable directory, type
```
git clone https://github.com/ionides/810f21.git
```
* You now have a local copy of the STATS 810 class materials.
* The local repository remembers the address of the remote repository it was cloned from.
+ You can pull any changes from the remote repository to your local repository using **git pull**.
```
[ionides@doob 810f21]$ git pull
Already up-to-date.
```
----------------
---------------
## A workflow to contribute to the 810f21 GitHub repository
* If you tell me your GitHub username, I could in principle add you as a developer of the `ionides/810f21` GitHub repository. Then you can commit changes directly.
* However, here, let's practice something a bit more fancy. We will follow a standard workflow for proposing a change to someone else's GitHub repository.
### Forking a project and making a pull request
**Forking** is making your own GitHub copy of a repository. A **pull request** is a way to ask the owner of the repository to pull your changes back into their version. The following steps guide you through a test example.
1. Go to `ionides/810f21` on GitHub, for example by searching for `810f21`.
2. Click `fork` at the top right-hand corner, and follow instructions to add a forked copy to your own GitHub account. It should now show up in your account as `my_username/810f21`.
3. Clone a local copy of the forked repository to your machine, e.g.,
```
git clone https://github.com/my_username/810f21.git
```
4. Move to the `810f21` directory and edit the file `sign_here.html` to check your own name.
5. It can be helpful to type
```
git status
```
regularly to check on the current state of the repository.
5. Commit this change to your local version of the forked `810f21`,
```
git add sign_here.html
git commit -m "sign up for my_name"
```
and see how the `git status` has changed. Another useful command for checking on the recent action in the repository is
```
git log
```
6. Push this change to your forked copy of `810f21` on GitHub:
```
git push
```
7. On the GitHub web site for the `my_username/810f21` fork, click `New pull request` and follow instructions. When you have successfully placed your pull request, the owner of the parent repository (me) will be notifed. I will then pull the modifications from your fork into `ionides/810f21`.
-------------