Skip to content

Commit e701ee2

Browse files
authored
Merge pull request #303 from coderefinery/radovan/concepts
small adjustments in the "concepts" episode
2 parents ee12d59 + d957687 commit e701ee2

1 file changed

Lines changed: 10 additions & 10 deletions

File tree

content/concepts.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,8 @@
99

1010
- {term}`repository`: The project, contains all data and history (commits, branches, tags).
1111
- {term}`commit`: Snapshot of the project, gets a unique identifier (e.g. `c7f0e8bfc718be04525847fc7ac237f470add76e`).
12-
- {term}`branch`: Independent development line. The main development line is often called `main`.
12+
- {term}`branch`: Independent development line. The main development line is often called `main`. Technically, a branch in Git
13+
is implemented as a pointer to a commit (imagine a sticky note with a branch name on it).
1314
- {term}`tag`: A pointer to one commit, to be able to refer to it later. Like a [commemorative plaque](https://en.wikipedia.org/wiki/Commemorative_plaque)
1415
that you attach to a particular commit (e.g. `phd-printed` or `paper-submitted`).
1516
- {term}`cloning <clone>`: Copying the whole repository to your laptop - the first time. It is not necessary to download each file one by one.
@@ -28,9 +29,9 @@ in a few different situations:
2829
server, and a supercomputer.
2930
* The parent repository could be a repository that you or your colleague own. A
3031
common use case for cloning is when working together within a smaller team
31-
where everyone has read and write access to the same git repository.
32+
where everyone has read and write access to the same Git repository.
3233
* Alternatively, cloning can be made from a public repository of a code that
33-
you would like to use. Perhaps you have no intention to work on the code, but
34+
you would like to use. Perhaps you have no intention to change the code, but
3435
would like to stay in tune with the latest developments, also in-between
3536
releases of new versions of the code.
3637

@@ -49,29 +50,28 @@ Forking and cloning
4950
When a fork is made on GitHub/GitLab a complete copy, of all or selected
5051
branches, of the repository is made. The copy will reside under a different
5152
account on GitHub/GitLab. Forking of a repository is of high relevance when
52-
working with a git repository to which you do not have write access.
53-
- In the fork repository commits can be made to the base branch (`main` or
53+
working with a Git repository to which you do not have write access.
54+
- In the fork repository commits can be made to the default branch (`main` or
5455
`master`), and to other branches.
5556
- The commits that are made within the branches of the fork repository can be
56-
contributed back to the parent repository by means of pull or merge requests.
57+
contributed back to the parent repository by means of **pull or merge requests**.
5758

5859

5960
## Synchronizing changes between repositories
6061

62+
- Repositories that are forked or cloned **do not automatically synchronize themselves**.
6163
- We need a mechanism to communicate changes between the repositories.
6264
- We will **pull** or **fetch** updates **from** remote repositories (we will soon discuss the difference between pull and fetch).
6365
- We will **push** updates **to** remote repositories.
64-
- We will learn how to suggest changes within repositories on GitHub and across repositories (**pull request**).
65-
- Repositories that are forked or cloned do not automatically synchronize themselves:
66-
We will learn how to update forks (by pulling from the "central" repository).
66+
- We will learn how to suggest changes within repositories on GitHub and across repositories (**pull requests**).
6767
- A main difference between cloning a repository and forking a repository is that the former
6868
is a general operation for generating copies of a repository to different computers,
6969
whereas forking is a particular operation implemented on GitHub/GitLab.
7070

7171

7272
## Should we clone or fork?
7373

74-
Should we all work on forks or should we all work inside one repository?
74+
Should we all work inside one repository and clone? Or should we all work on forks?
7575

7676
- For most small or medium-sized research projects you probably want to **work by
7777
cloning a repository** that all research group has write access to (we will

0 commit comments

Comments
 (0)