Skip to content
Snippets Groups Projects
essential_commands.md 2.14 KiB
Newer Older
Sylvain's avatar
Sylvain committed
## 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
$ git pull <remote> <branch>
Sylvain's avatar
Sylvain committed
$ git status
$ git add myFile.txt # example
$ git commit -m "myMessage" # example
$ git push <remote> <branch>
Sylvain's avatar
Sylvain committed
```


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

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

<div class="fragment">
<br>
Sylvain's avatar
Sylvain committed
Verify its `status` with:
```bash
$ git status
```

## Modify a file
Sylvain's avatar
Sylvain committed

Modify and rename `addTwoNumbers.m` in the folder `src/firstCommit` as `addTwoNumbers_myName`:
Sylvain Arreckx's avatar
Sylvain Arreckx committed

```bash
$ cd src/firstCommit
$ mv addTwoNumbers.m addTwoNumbers_myName.m
Sylvain Arreckx's avatar
Sylvain Arreckx committed
```

Sylvain's avatar
Sylvain committed
<br>
Open the file using the `Visual Studio Code` editor (or any other editor)
and correct the line
Sylvain's avatar
Sylvain committed
```Matlab
Laurent Heirendt's avatar
Laurent Heirendt committed
c = a - b;
Sylvain's avatar
Sylvain committed
```


## 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
$ git add addTwoNumbers_myName.m
$ git status
Sylvain's avatar
Sylvain committed
# returns the same as before, generally in green (means staged)
```

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


## Add a commit message

```bash
Laurent Heirendt's avatar
Laurent Heirendt committed
$ git commit -m "Correcting formula for adding 2 numbers"
Sylvain's avatar
Sylvain committed
$ git status
```


Laurent Heirendt's avatar
Laurent Heirendt committed
## Push your file to your fork
Sylvain's avatar
Sylvain committed

```bash
Laurent Heirendt's avatar
Laurent Heirendt committed
$ git push origin add-2-numbers
Sylvain's avatar
Sylvain committed
```

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

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