diff --git a/best_practices.md b/best_practices.md index 2ee462cba34902476a1e4f02f3a869643e48a54f..5b9c42ba0106e4682461db3cd7a67acf21a5a974 100644 --- a/best_practices.md +++ b/best_practices.md @@ -4,6 +4,7 @@ * `pull` before `push` * Work on your **own** branch (in your own fork) * Do **not** `push` to `master` or `develop` (submit PR) +* Get your code reviewed by submitted a PR * Do **not** combine `git` commands ```sh $ git commit -am "myMessage" # do not do this diff --git a/branches.md b/branches.md index 4cf120ff7cf7a69aa35ba99f3c1747ff84b3f64b..9cf292a55a81a6093e05e5e0400fbfaa18006de1 100644 --- a/branches.md +++ b/branches.md @@ -51,16 +51,13 @@ 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. @@ -68,21 +65,21 @@ 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** - + <br><br> 2. Compare the branches - + <ol start="3"> <li>Submit the MR - </li> + </li> </ol> @@ -92,15 +89,15 @@ Detailed information is [help.github.com/articles/creating-a-pull-request/](http 1. Click on **New pull request** - + <br><br> 2. Compare the branches - + <ol start="3"> - <li>Submit the MR + <li>Submit the PR - </li> + </li> </ol> diff --git a/forks.md b/forks.md index 3fc815cbb52a264033276b9d41d3a4f0a7ecda1c..2899290438d40fe9cbcb5ed00568b2ded2369fad 100644 --- a/forks.md +++ b/forks.md @@ -9,10 +9,11 @@ Remember: - 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 + ## Clone your fork diff --git a/github_gitlab.md b/github_gitlab.md index 683c6757aefefc43902c85beb00301a3ce44c89b..ee7d8a57fee2e435fc3e08d4dbae884a2d0e4c8c 100644 --- a/github_gitlab.md +++ b/github_gitlab.md @@ -7,7 +7,10 @@ GitHub is **public**, whereas GitLab is **restricted/private**. Positive point: GitHub and GitLab are (almost) the same. -## GitHub +## GitHub (Live Demo) -## GitLab +## GitLab (Live Demo) + + +## Open an issue (Live Demo) diff --git a/installation.md b/installation.md index b33ba488830d5789c9c3f25e1446c07b402ccae7..ec24784591a672b732d859ff0bbecb9bea84583b 100644 --- a/installation.md +++ b/installation.md @@ -55,7 +55,7 @@ $ git --version Test whether your username and email have been registered ```sh -$ git config -l +$ git config --list ``` <br>