diff --git a/README.md b/README.md index 4526ff4452a5f8025bbd5cb006e6f8eb32039ed6..c73b014f1b100c74197663ec142114cd31859f3b 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,6 @@ Training material for the Git for Beginners ABiMS training session ## Course Outline ### Short Intro - 1. What is version management ? 1. What is Git and why did we choose it ? 1. What is GitLab and why did we choose it ? @@ -14,10 +13,16 @@ Training material for the Git for Beginners ABiMS training session 1. Does everyone have an account on GitLab ? ### Git Basics + 1. Some definitions 1. Creating a repository 1. Adding / editing / removing files & folders 1. Committing changes - 1. Pushing changes to the repository + +### Using a Repository Remotely + 1. Motivation + 1. Cloning a repository + 1. Modifying the local repository + 1. Propagating changes to the remote repository ### Branching Basics 1. Default branches @@ -32,10 +37,6 @@ Training material for the Git for Beginners ABiMS training session 1. Handling Merge Requests 1. Resolving Conflicts -### Using Git through the command line - 1. Configuring remote access to GitLab - 1. Git Survival Memo (`fetch`, `update`) - ### Using Git through third party tools 1. Using Git inside R-Studio 1. Using Git inside PyCharm diff --git a/git-basics/README.md b/git-basics/README.md index 6b13aa1d2bd1d18ca54fb24cb8fb231eb41c240f..d3408d497066a89369de754e0226b525bd9867a9 100644 --- a/git-basics/README.md +++ b/git-basics/README.md @@ -26,48 +26,114 @@ Git provides operations to specify which files should be part of a commit. ## Create Your First Repository - ### [Log In to GitLab](/git-basics/media/gitlab-login.mp4) +### [Log In to GitLab](/git-basics/media/gitlab-login.mp4) - Log in to GitLab using your favourite account settings (GitLab, Google, GitHub, Twitter...) +Log in to GitLab using your favourite account settings (GitLab, Google, GitHub, Twitter...) -  + - ### [Create a new Project](/git-basics/media/gitlab-create-project.mp4) - - 1. Select **Create a Project** - 1. Select **Create Blank Project** - 1. Give it a sensible name for a collection of animal descriptions - 1. Keep the visibility **private** - 1. Check the **Initialize repository with a README** - 1. Select **Create Project** +### [Create a new Project](/git-basics/media/gitlab-create-project.mp4) + +1. Select **Create a Project** +1. Select **Create Blank Project** +1. Give it a sensible name for a collection of animal descriptions +1. Keep the visibility **private** +1. Check the **Initialize repository with a README** +1. Select **Create Project** -  + - ### GitLab User Interface Main Panels +## GitLab User Interface Main Panels - #### Project Summary Information +### Project Summary Information - Recap with your project's name the number of _commits_, _branches_ (more on these soon) and _tags_ as well as storage space occupied by project files. +Recap with your project's name the number of _commits_, _branches_ (more on these soon) and _tags_ as well as storage space occupied by project files. -  + - #### Current View and Most Recent Activity +### Current View and Most Recent Activity - Which _branch_ are we looking at ? - What was the most recent activity in this branch ? +Which _branch_ are we looking at ? +What was the most recent activity in this branch ? -  + + +### Files / Folders in the Current View + +Which files folders are part of the current _branch_ ? +If there's a `README.md` file, what's its contents ? + + + + +## Using the Web IDE + +The Web IDE provides all that is required to manipulate a project's files. + +### Left Panel + +The left panel shows a file explorer with at the top, buttons for: + - Creating new files. + - Uploading files. + - Creting new folders. + +  + +In the file explorer, highlighting a file/folders gives acces to a contextual menu with a set of operations: `rename/move` or `delete` for files and folders, `new file`, `upload file` and `new directory` for folders. + +Icons on the right of file name give clues as to what has been modified since the latest *commited* state of the current branch : + - An orange dotted square icon after a file name means it has been modified + +  + + - A green dotted square icon after a file name means it has been added + +  + +For folders, the number in the square icon represents the number of files inside the folder that have been affected by changes since the latest commit. + +At the bottom of the left panel, a button allows to *commit* all the changes (i.e.: integrate them into the repository). + + + +### Center Panel + +The center panel allows editing or viewing files using a tab for each currently opened file. + +## Commiting Changes + +Using the `Create commit...` allow to tune how modifications will be propagated to the repository: + + - A text area recaps the modifications included in the commit, which can be edited at will. + - Two radio buttons allow to choose whether the commit will be made in the current branch (default choice) or if a new branch will be created on the fly + - A checkbox `Start a new merge request...`(checked by default) can be used to create a *merge request* matching the commit. + +### Merge Requests vs. Basic Commits + + - A basic *commit* will immediately propagate all modifications to the selected branch. The only remaining trace of the modifications will be a commit id (or hash code). This may be adapted to a set of small changes to a branch used by a single developer. + + - A *merge request* will encapsulate all the modifications in a changeset and not apply them immediately to the selected branch. To actually integrate the modifications, someone will have to `Merge` (!) the merge request. A best practice is to create merge requests when a changeset is destined to another branch, especially when the destination branch is also used by other participants. When creating a merge request, GitLab allows to add more comments as well as to assign the merge request to another project participant. Depending on project configuration, developers will not be allowed to commit to some branches (typically `main` and `develop`). The will need to create a merge request if they want their changes to be integrated into these protected branches. Project maintainers will then review the merge request before actually merging the changes. + + +## Your Turn + +Take some time to complete [the exercises](./exercises.md) + + + + + + + + + + - #### Files / Folders in the Current View - Which files folders are part of the current _branch_ ? - If there's a `README.md` file, what's its contents ? -  -# Git Basics - Exercises diff --git a/git-basics/media/addition_icon.png b/git-basics/media/addition_icon.png new file mode 100644 index 0000000000000000000000000000000000000000..01a0d51da2b50092405b25dbbc9515931caa17e9 Binary files /dev/null and b/git-basics/media/addition_icon.png differ diff --git a/git-basics/media/commit_button.png b/git-basics/media/commit_button.png new file mode 100644 index 0000000000000000000000000000000000000000..da01cb9fe7291429ac76f2d58f6019afd1770b4e Binary files /dev/null and b/git-basics/media/commit_button.png differ diff --git a/git-basics/media/edit_icons.png b/git-basics/media/edit_icons.png new file mode 100644 index 0000000000000000000000000000000000000000..8a85a658c7700bbf46564d8ca81971670ec633ab Binary files /dev/null and b/git-basics/media/edit_icons.png differ diff --git a/git-basics/media/modification_icon.png b/git-basics/media/modification_icon.png new file mode 100644 index 0000000000000000000000000000000000000000..13cdcec538c60cb2a3bd12f1ff3071458de7c2d7 Binary files /dev/null and b/git-basics/media/modification_icon.png differ