essential_commands.md 2.14 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
42
$ cd src/firstCommit
$ mv addTwoNumbers.m addTwoNumbers_myName.m
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
63
64
```


## Add your file to the stage

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

<div class="fragment">
<br>
Now, add the file (bring it on stage)
```bash
Laurent Heirendt's avatar
Laurent Heirendt committed
65
66
$ git add addTwoNumbers_myName.m
$ git status
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
# returns the same as before, generally in green (means staged)
```

<div class="fragment">
<br>
**ADVANCED**: see your changes in the terminal
```bash
$ git diff
```
exit with `q`


## Add a commit message

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


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

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

<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
104
* Modify and rename `secondCommit/multiplyTwoNumbers_myName.m`
105
* Push the file `secondCommit/multiplyTwoNumbers_myName.m`
Laurent Heirendt's avatar
Laurent Heirendt committed
106
* Don't forget to edit <font color="red">`_myName`</font>
107
108
109
110
111

<div class="fragment">
<br>
Commands:
```bash
Laurent Heirendt's avatar
Laurent Heirendt committed
112
113
114
115
$ git checkout develop
$ git pull origin develop
$ git checkout -b multiply-2-numbers
# make changes to file
116
$ git add secondCommit/multiplyTwoNumbers_myName.m
Laurent Heirendt's avatar
Laurent Heirendt committed
117
$ git commit -m "Corrected formula for multiplying 2 numbers"
118
$ git status
Laurent Heirendt's avatar
Laurent Heirendt committed
119
$ git push origin multiply-2-numbers
120
121
$ git log # optional
```