forked from rogerdudler/git-guide
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathindex.html
229 lines (226 loc) · 10.5 KB
/
index.html
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
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
<title>git 101 - Yseop</title>
<link rel="icon" href="img/favicon.png" />
<link href="https://fonts.googleapis.com/css?family=Roboto+Mono" rel="stylesheet">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/normalize/8.0.1/normalize.min.css" type="text/css">
<link rel="stylesheet" href="css/style.css" type="text/css">
</head>
<body>
<div class="scrollblock block-title">
<h1>git - the simple guide for Yseopers</h1>
</div>
<a name="create"></a>
<div class="scrollblock block-create">
<h2>create a new repository</h2>
<p>
Create a new directory, open it and perform a <br />
<code>git init</code><br />
to create a new git repository.
</p>
</div>
<a name="checkout"></a>
<div class="scrollblock block-checkout">
<h2>checkout a repository</h2>
<p>
Create a working copy of a local repository by running the command<br />
<code>git clone /path/to/repository</code><br />
when using a remote server, your command will be<br />
<code>git clone username@host:/path/to/repository</code><br />
when using GitHub, your command will likely be<br />
<code>git clone [email protected]:username/repository.git</code>
</p>
</div>
<a name="trees"></a>
<div class="scrollblock block-trees">
<h2>workflow</h2>
<p>
Your local repository consists of three "trees" maintained by git.<br />
The first one is your <code>Working Directory</code> which holds the actual files.<br />
The second one is the <code>Index</code> which acts as a staging area.<br />
And finally the <code>HEAD</code> which points to the last commit you've made.
</p>
<img src="img/trees.png" alt="" />
</div>
<a name="add"></a>
<div class="scrollblock block-add">
<h2>add & commit</h2>
<p>
You can propose changes (add it to the <b>Index</b>) using<br />
<code>git add <filename></code><br />
This is the first step in the basic git workflow.<br />
To actually commit these changes, use<br />
<code>git commit -m "Commit message"</code><br />
or, to do both adding all modified files and commit in one command<br />
<code>git commit -am "Commit message"</code><br />
Now the file is committed to the <b>HEAD</b>, but not in your remote repository yet.
</p>
</div>
<a name="push"></a>
<div class="scrollblock block-remote">
<h2>pushing changes</h2>
<p>
Your changes are now in the <b>HEAD</b> of your local working copy. To send those changes to your remote
repository, execute <br />
<code>git push origin develop</code><br />
Change <i>develop</i> to whatever branch you want to push your changes to.
<br /><br />
If you do not specify a branch, git will try to push into a remote branch with the same name as your local branch.<br />
If it cannot find one, it will create it.
</p>
</div>
<a name="branching"></a>
<div class="scrollblock block-branching">
<h2>branching</h2>
<p>
Branches are used to develop features isolated from each other. The <i>master</i> branch is the "default"
branch when you create a repository.<br />To checkout an existing branch, you can use <br />
<code>git checkout <existing_branch></code><br />Use other branches for development and merge them back to the master
branch upon completion.
</p>
<img src="img/branches.png" alt="" />
<p>
Create a new branch named "feature_x" and switch to it using<br />
<code>git checkout -b feature_x</code><br />
switch back to master<br />
<code>git checkout master</code><br />
and delete the branch again<br />
<code>git branch -d feature_x</code><br />
a branch is <i>not available to others</i> unless you push the branch to your remote repository<br />
<code>git push origin <branch></code>
</p>
</div>
<a name="update"></a>
<div class="scrollblock block-merging">
<h2>update & merge</h2>
<p>
To retrieve the latest changes made one the remote repository, execute<br />
<code>git fetch</code><br />
This will update your <i>refs</i>, which store the state of the remote branches available.<br />
</p>
<p>
To update your local repository to the newest commit (corresponding to the branch you are currently on), execute <br />
<code>git pull</code><br />
in your working directory to <i>fetch</i> and <i>merge</i> remote changes.<br />
</p>
<p>
To merge another branch into your active branch (e.g. <i>develop</i>), use<br />
<code>git merge <branch></code><br />
In both cases git tries to auto-merge changes. Unfortunately, this is not always possible and results in <i>conflicts</i>.<br />
You are responsible to merge those <i>conflicts</i>
manually by editing the files shown by git. After changing, you need to mark them as merged with<br />
<code>git add <filename></code><br />
Before merging changes, you can also preview them by using<br />
<code>git diff <source_branch> <target_branch></code><br />
This also works for individual files<br />
<code>git diff <filename></code>
</p>
</div>
<a name="checkout-replace"></a>
<div class="scrollblock block-checkout-replace">
<h2>replace local changes</h2>
<p>
In case you did something wrong, which for sure never happens ;), you can replace local changes using the
command<br />
<code>git checkout <filenames></code><br />
This replaces the changes in your working tree with the last content in HEAD.<br />
Changes already added to the index, as well as new files, will be kept.
</p>
<p>
If you instead want to drop all your local changes and commits, fetch the latest history from the server
and point your local branch at it like this<br />
<code>git fetch</code><br />
<code>git reset --hard origin/<branch_you_want_to_reset_to></code>
</p>
</div>
<a name="rebase"></a>
<div class="scrollblock block-rebase">
<h2>rewrite history</h2>
<p>
When starting a branch (let say, from <i>develop</i>), a good practice is to keep your branch up to date with its source branch.<br />
To do this, we use an operation called <i>rebase</i><br />
</p>
<img src="img/rebase.png" />
<p>
Here the <i>branch</i>, started from <i>develop</i>, was <i>rebased</i> on its last commit, with the following command<br />
<code>git rebase origin/develop</code>
</p>
<p>
Sometimes, we do "dirty" commits (no naming convention/description), for testing purpose or just to save our works.<br />
Afterward, it's a good practice to clean up our history, by doing an <i>interactive rebase</i><br />
<code>git rebase -i HEAD~5</code>
</p>
</div>
<!-- <a name="tagging"></a>
<div class="scrollblock block-tagging">
<h2>tagging</h2>
<p>
It's recommended to create tags for software releases. this is a known concept, which also exists in SVN.
You can create a new tag named <i>1.0.0</i> by executing<br />
<code>git tag 1.0.0 1b2e1d63ff</code><br />
the <i>1b2e1d63ff</i> stands for the first 10 characters of the commit id you want to reference with your
tag. You can get the commit id by looking at the... <br />
</p>
</div> -->
<a name="log"></a>
<div class="scrollblock block-log">
<h2>log</h2>
<p>
In its simplest form, you can study repository history using..
<code>git log</code><br />
You can add a lot of parameters to make the log look like what you want. To see only the commits of a
certain author:<br />
<code>git log --author=bob</code><br />
To see a very compressed log where each commit is one line:<br />
<code>git log --pretty=oneline</code><br />
Or maybe you want to see an ASCII art tree of all the branches, decorated with the names of tags and
branches: <br />
<code>git log --graph --oneline --decorate --all</code><br />
See only which files have changed: <br />
<code>git log --name-status</code><br />
These are just a few of the possible parameters you can use. For more, see
<code>git log --help</code><br />
</p>
</div>
<a name="hints"></a>
<div class="scrollblock block-hints">
<h2>useful hints</h2>
<p>
built-in git GUI<br />
<code>gitk</code><br />
use colorful git output<br />
<code>git config color.ui true</code><br />
show log on just one line per commit<br />
<code>git config format.pretty oneline</code><br />
</p>
</div>
<a name="resources"></a>
<div class="scrollblock block-resources">
<h2>links & resources</h2>
<h3>cheatsheet</h3>
<p>
<ul>
<li> <a href="files/git_cheat_sheet.pdf">All you need to survive in the git wilderness</a></li>
</ul>
</p>
<h3>guides</h3>
<p>
<ul>
<li><a href="http://book.git-scm.com/">Git Community Book</a></li>
<li><a href="http://think-like-a-git.net/">Think like a git</a></li>
<li><a href="http://help.github.com/">GitHub Help</a></li>
<li><a href="http://marklodato.github.com/visual-git-guide/index-en.html">A Visual Git Guide</a></li>
</ul>
</p>
<h3>get help</h3>
<p>
<ul>
<li><a href="#">Ask your friendly colleagues on #Slack :)</a></li>
</ul>
</p>
</div>
</body>
</html>