Skip to content
Snippets Groups Projects
essential_commands.md 2.07 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
$ git mv addTwoNumbers_myName.m addTwoNumbers_laurent.m # replace myName
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>
**ADVANCED**: see your changes in the terminal
Sylvain's avatar
Sylvain committed
```bash
$ git diff
Sylvain's avatar
Sylvain committed
```
exit with `q`
Sylvain's avatar
Sylvain committed

<div class="fragment">
<br>
Now, add the file (bring it on stage)
Sylvain's avatar
Sylvain committed
```bash
$ git add addTwoNumbers_laurent.m # replace myName
$ git status
# returns the same as before, generally in green (means staged)
Sylvain's avatar
Sylvain committed
```
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

**Exercice 1:**

* Edit the test in `test/suite`
Sylvain's avatar
Sylvain committed

<div class="fragment">
<br>
<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>