From 21361f496fd866ad130502220ef892b1ad7c3666 Mon Sep 17 00:00:00 2001 From: Kristian <78126741+Ernst-hub@users.noreply.github.com> Date: Tue, 26 Sep 2023 11:43:38 +0200 Subject: [PATCH] spelling error lecture 2 (#184) --- s2_organisation_and_version_control/git.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/s2_organisation_and_version_control/git.md b/s2_organisation_and_version_control/git.md index b2697ff5b..4daedb41a 100644 --- a/s2_organisation_and_version_control/git.md +++ b/s2_organisation_and_version_control/git.md @@ -34,7 +34,7 @@ this into your own projects depends, but you are at least expected to be familia The name "git" was given by Linus Torvalds when he wrote the very first version. He described the tool as "the stupid content tracker" and the name as (depending on your mood): - + * Random three-letter combination that is pronounceable, and not actually used by any common UNIX command. The fact that it is a mispronunciation of "get" may or may not be relevant. * Stupid. Contemptible and Despicable. simple. Take your pick from the dictionary of slang. @@ -142,7 +142,7 @@ working together on the same project. I am continuously updating/changing some of the material during the course and I therefore recommend that you each day before the lecture do a `git pull` on your local copy -4. Git may seems like a waste of time when solutions like dropbox, google drive ect exist, and it is +4. Git may seem like a waste of time when solutions like dropbox, google drive ect exist, and it is not completely untrue when you are only one or two working on a project. However, these file management systems falls short when hundreds to thousands of people work together. For this exercise you will go through the steps of sending an open-source contribution: @@ -223,17 +223,17 @@ working together on the same project. ??? question "Knowledge question 1" How do you know if a certain directory is a git repository? - + ??? success "Solution" - + You can check if there is a ".git" directory. Alternative you can use the `git status` command. ??? question "Knowledge question 2" Explain what the file `gitignore` is used for? - + ??? success "Solution" - + The file `gitignore` is used to tell git which files to ignore when doing a `git add .` command. This is useful for files that are not part of the codebase, but are needed for the code to run (e.g. data files) or files that contain sensitive information (e.g. `.env` files that contain API keys and passwords). @@ -242,9 +242,9 @@ working together on the same project. You have two branches - *main* and *devel*. What sequence of commands would you need to execute to make sure that *devel* is in sync with *main*? - + ??? success "Solution" - + ```bash git checkout main git pull @@ -255,9 +255,9 @@ working together on the same project. ??? question "Knowledge question 4" What best practices are you familiar with regarding version control? - + ??? success "Solution" - + * Use a descriptive commit message * Make each commit a logical unit * Incorporate others' changes frequently