essential_commands.md 2.07 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
## The 5 essential commands

<br>
**Yes**, you only need 5 commands!

<br>
`pull, status, add, commit, push`

<br>
or in other words (remember these!):
```bash
12
$ git pull <remote> <branch>
13
14
15
$ git status
$ git add myFile.txt # example
$ git commit -m "myMessage" # example
16
$ git push <remote> <branch>
17
18
19
```


Laurent Heirendt's avatar
Laurent Heirendt committed
20
## Pull the latest version of an existing branch
21

Laurent Heirendt's avatar
Laurent Heirendt committed
22
Pull the latest revision on branch `add-2-numbers`:
23
```bash
24
$ git pull origin add-2-numbers
25
26
27
# Already up to date
```

28
29
<div class="fragment">
<br>
30
31
32
33
34
Verify its `status` with:
```bash
$ git status
```

35

36
## Modify a file
37

38
Modify and rename `addTwoNumbers.m` in the folder `src/firstCommit` as `addTwoNumbers_myName`:
39
40

```bash
41
$ cd src/firstCommit
Laurent Heirendt's avatar
Laurent Heirendt committed
42
$ git mv addTwoNumbers_myName.m addTwoNumbers_laurent.m # replace myName
43
44
45
```

<br>
46
47
Open the file using the `Visual Studio Code` editor (or any other editor)
and correct the line
48
```Matlab
Laurent Heirendt's avatar
Laurent Heirendt committed
49
c = a - b;
50
51
52
53
54
55
56
57
58
59
60
61
62
```


## Add your file to the stage

First, check the repository status
```bash
$ git status
# uncommitted changes (displayed in red)
```

<div class="fragment">
<br>
Laurent Heirendt's avatar
Laurent Heirendt committed
63
**ADVANCED**: see your changes in the terminal
64
```bash
Laurent Heirendt's avatar
Laurent Heirendt committed
65
$ git diff
66
```
Laurent Heirendt's avatar
Laurent Heirendt committed
67
exit with `q`
68
69
70

<div class="fragment">
<br>
Laurent Heirendt's avatar
Laurent Heirendt committed
71
Now, add the file (bring it on stage)
72
```bash
Laurent Heirendt's avatar
Laurent Heirendt committed
73
74
75
$ git add addTwoNumbers_laurent.m # replace myName
$ git status
# returns the same as before, generally in green (means staged)
76
```
Laurent Heirendt's avatar
Laurent Heirendt committed
77

78
79
80
81
82


## Add a commit message

```bash
Laurent Heirendt's avatar
Laurent Heirendt committed
83
$ git commit -m "Correcting formula for adding 2 numbers"
84
85
86
87
$ git status
```


Laurent Heirendt's avatar
Laurent Heirendt committed
88
## Push your file to your fork
89
90

```bash
Laurent Heirendt's avatar
Laurent Heirendt committed
91
$ git push origin add-2-numbers
92
93
94
95
96
97
98
99
100
101
102
103
104
```

<div class="fragment">
<br>
**ADVANCED**: see the log of all the commits (and your last one) in the terminal
```bash
$ git log
```
exit by typing `q`


## Do it yourself

Laurent Heirendt's avatar
Laurent Heirendt committed
105
106
107
**Exercice 1:**

* Edit the test in `test/suite`
108
109
110

<div class="fragment">
<br>
Laurent Heirendt's avatar
Laurent Heirendt committed
111
112
113
114
115
116
117
118
119
<img src="img/icon-live-demo.png" height="100px">

<div class="fragment">
**Exercice 2:**

* Checkout a new branch named `multiply-2-numbers`
* Rename and modify `src/secondCommit/multiplyTwoNumbers_myName.m`
* Push the file `src/secondCommit/multiplyTwoNumbers_myName.m`
* Don't forget to edit <font color="red">`_myName`</font>