Merge branch 'laurent' into 'develop'

Minor changes to slides

See merge request !13

slides/best_practices.md

@@ -3,7 +3,8 @@
 * `clone` a repository, do not download the `.zip` file.
 * `pull` before `push`
 * Work on your **own** branch (in your own fork)
-* Do **not** `push` to `master` or `develop` (submit PR)
+* Do **not push** to `master` or `develop`, but **submit a PR**
+* Get your code **reviewed** by your peers (submit a PR!)
 * Do **not** combine `git` commands
 ```sh
 $ git commit -am "myMessage" # do not do this
@@ -14,9 +15,8 @@ $ git add myFile.txt
 ```
 
 
-* Commit only a few files at once
-* Submit a PR instead of pushing directly
-* Always sync your fork before starting to work
+* Commit **only a few files** at once (after multiple separate `git add` commands)
+* Always **sync your fork** before starting to work
 ```sh
 $ git remote -v # verify to have the right remote set
 $ git fetch upstream
@@ -26,4 +26,4 @@ $ git push origin master # do not do git push (!)
 * `Push` often - avoid conflicts
 
 <br><br>
-**A `push` a day keeps the conflict away**
+Remember: **A `push` a day keeps conflicts away!**

slides/branches.md

@@ -9,13 +9,34 @@ The master branch:
 ## One branch per feature
 
 Assume that you want to work on a function for a matrix-vector operation.
-```shell
+```sh
 $ git checkout -b matrix_vect_mult_myName
+# creates the branch locally
 ```
 The `-b` flag creates the branch.
 
 <img src="img/branch-create.png" class="branch-create" />
 
+Push the branch to the remote repository
+```sh
+$ git push
+```
+
+
+If you do that, `git` will complain
+```sh
+fatal: The current branch matrix_vect_mult_myName has no upstream branch.
+To push the current branch and set the remote as upstream, use
+
+    git push --set-upstream origin matrix_vect_mult_myName
+```
+
+<br>
+Follow the advice and do:
+```sh
+$ git push --set-upstream origin matrix_vect_mult_myName
+```
+
 
 ## Switch between branches
 
@@ -23,7 +44,7 @@ In your terminal, you may see the name of the branch you are on.
 
 List available branches of the repository
 ```sh
-$ git branch
+$ git branch --list
 ```
 
 <div class="fragment">
@@ -35,7 +56,7 @@ $ git checkout <branch_name>
 
 <div class="fragment">
 <br>
-You can switch back to master with
+You can switch back to the `master` branch with
 ```sh
 $ git checkout master
 ```
@@ -51,38 +72,35 @@ Only difference: you are on your own branch.
 
 ## Merge a branch
 
-If you want your feature on the `develop` or `master` branches, merge!
-
+If you want your feature on the `develop` or `master` branches,
 **submit a MR or a PR** via the Github/Gitlab interface.
 
+<br>
+Use the **interface** to make use of your peers to review your code!
+
 <img src="img/branch-merge.png" class="branch-merge" />
-<div class="fragment">
-**ADVANCED**: You can see the differences between branches
-```sh
-$ git diff master..matrix_vect_mult_myName
-```
 
 <br>
-You can delete the branch via the interface.
+Once merged, you can delete the branch via the interface.
 
 
 ## Gitlab interface
 
-Detailed information is [docs.gitlab.com/ee/gitlab-basics/add-merge-request.html](https://docs.gitlab.com/ee/gitlab-basics/add-merge-request.html).
+Detailed information is [docs.gitlab.com/ce/gitlab-basics/add-merge-request.html](https://docs.gitlab.com/ce/gitlab-basics/add-merge-request.html).
 
 1. Click on **New merge request**
 
-![alt text](https://docs.gitlab.com/ee/gitlab-basics/img/merge_request_new.png "New Merge Request")
+![New Merge Request](https://docs.gitlab.com/ee/gitlab-basics/img/merge_request_new.png)
 <br><br>
 2. Compare the branches
 
-![alt text](https://docs.gitlab.com/ee/gitlab-basics/img/merge_request_select_branch.png "Compare branches")
+![Compare branches](https://docs.gitlab.com/ee/gitlab-basics/img/merge_request_select_branch.png)
 
 
 <ol start="3">
   <li>Submit the MR
 
-  ![alt text](https://docs.gitlab.com/ee/gitlab-basics/img/merge_request_page.png "Submit MR")</li>
+  ![Submit MR](https://docs.gitlab.com/ee/gitlab-basics/img/merge_request_page.png)</li>
 </ol>
 
 
@@ -92,15 +110,15 @@ Detailed information is [help.github.com/articles/creating-a-pull-request/](http
 
 1. Click on **New pull request**
 
-![alt text](https://help.github.com/assets/images/help/pull_requests/pull-request-start-review-button.png "New pull request")
+![New pull request](https://help.github.com/assets/images/help/pull_requests/pull-request-start-review-button.png)
 <br><br>
 2. Compare the branches
 
-![alt text](https://help.github.com/assets/images/help/pull_requests/choose-base-and-compare-branches.png "Compare branches")
+![Compare branches](https://help.github.com/assets/images/help/pull_requests/choose-base-and-compare-branches.png)
 
 
 <ol start="3">
-  <li>Submit the MR
+  <li>Submit the PR
 
-  ![alt text](https://help.github.com/assets/images/help/pull_requests/pullrequest-send.png "Submit MR")</li>
+  ![Submit MR](https://help.github.com/assets/images/help/pull_requests/pullrequest-send.png)</li>
 </ol>

slides/essential_commands.md

@@ -7,7 +7,7 @@
 `pull, status, add, commit, push`
 
 <br>
-or in other words (remember these!)
+or in other words (remember these!):
 ```shell
 $ git pull
 $ git status

slides/forks.md

@@ -5,14 +5,15 @@ You **fork** when you want to work on a public repository or a protected reposit
 Remember:
 
 - A **fork** is your own **copy** of a repository.
-- A **fork** can have multiple **branches**
+- A **fork** can have multiple **branches**.
 - A **fork** is not a **branch**, but can have multiple **branches**.
 
 
-## Fork on GitLab
+## Fork via interface
 
+Browse to the original repository and click on the button `Fork`:
 
-## Fork on GitHub
+![Fork the repo](https://help.github.com/assets/images/help/repository/fork_button.jpg)
 
 
 ## Clone your fork
@@ -31,7 +32,7 @@ $ cd forkMyRepo
 
 ## Add the address of the original repository
 
-Add the `upstream` (where you copied from)
+Add the `upstream` address (original/protected repository)
 ```sh
 $ git remote add upstream https://git-r3lab.uni.lu/origGroup/origRepo.git
 ```

slides/github_gitlab.md

@@ -7,7 +7,14 @@ GitHub is **public**, whereas GitLab is **restricted/private**.
 Positive point: GitHub and GitLab are (almost) the same.
 
 
-## GitHub
+## GitHub (Live Demo)
 
+[www.github.com](www.github.com)
 
-## GitLab
+
+## GitLab (Live Demo)
+
+[https://git-r3lab.uni.lu](https://git-r3lab.uni.lu)
+
+
+## Open an issue (Live Demo)

slides/installation.md

@@ -55,14 +55,14 @@ $ git --version
 Test whether your username and email have been registered
 
 ```sh
-$ git config -l
+$ git config --list
 ```
 
 <br>
 This should list the configuration with `user.name` and `user.email`.
 
 
-## I need `The COBRAToolbox` - How?
+## I need `The COBRAToolbox`?
 
 Simply `clone` the repository (i.e., retrieve a copy)
 ```sh
@@ -77,7 +77,7 @@ Any other rudimentary method such as
 shall **be avoided**!
 
 
-## How do I `clone` a repository?
+## How do I generally `clone` a repository?
 
 You can clone any other repository with:
 ```sh

slides/overview.md

@@ -8,6 +8,6 @@
     * `clone/pull` / `status` / `add` / `commit` / `push`
 5. Branches <!--(10 min)//-->
 6. Forks <!--(10 min)//-->
-7. Good practices
+7. Best practices
 8. Practical session  <!--(40 min)//-->
 9. Evaluation <!--(10 min)//-->

slides/the_terminal.md

-## The Linux Terminal
+## The Terminal (shell)
 
 Starting the terminal presents itself with a line where you can enter a command:
 ```sh
@@ -13,8 +13,8 @@ $
 ```
 
 <br>
-When you open your terminal (git shell) and unless otherwise configured, you are located
-in your home directory, denoted as `~/`.
+When you open your terminal (shell), you are located
+in your home directory (unless otherwise configured), denoted as `~/`.
 
 
 ## Essential Linux commands
@@ -36,7 +36,10 @@ $ cd myDirectory
 Change the directory 1 level and 2 levels up
 ```sh
 $ cd ..
+# 1 level up
+
 $ cd ../..
+# 2 levels up
 ```