chore: improve wording, grammar fixes
This commit is contained in:
+13
-4
@@ -2,6 +2,7 @@
|
||||
::: details {open}
|
||||
If you are already familiar with this, all you need to know is that the D-INFK GitLab can be found at https://gitlab.inf.ethz.ch
|
||||
:::
|
||||
<!-- TODO: SSH -->
|
||||
|
||||
|
||||
Git is a Version Control System, short VCS. It enables you to *version* your code, allowing you to effectively, safely and efficiently work on software together with other people.
|
||||
@@ -21,7 +22,7 @@ First a few terms to remember:
|
||||
- Commit: The act of making changes "permanent" in a git repo. Permanent in quotes, because this can be undone
|
||||
- Remote: A Remote is a computer different from the local one (typically referred to as server) that has a copy of the repo and is connected to the current repo
|
||||
- Stage: The act of preparing changes for commit. This is used to decide which changes to commit together or not to commit yet
|
||||
- Diff: Short for difference, a comparison of two versions of a file
|
||||
- Diff: Short for difference, a comparison of two versions of a file (or multiple files)
|
||||
- Pull: Pulls commits synced to the remote into the current tree
|
||||
- Push: Pushes local commits to the remote
|
||||
- Rebase: If you have committed changes to the repo locally and somebody in the mean time has pushed changes to the remote, your own copy needs to be *rebased* on that version
|
||||
@@ -32,17 +33,17 @@ that can't yet be added to `main` due to possibly needing to fix issues in `main
|
||||
- Merge: The act of combining two development histories, typically of two branches
|
||||
- Dirty tree: If there are uncommitted changes in your file tree.
|
||||
- Stash: A stack on which you can store changes that are not ready to be committed, for example to pull in changes without having to a rebase straight away,
|
||||
or if you are working on something, then notice a different issue, but your changes are not ready to commit.
|
||||
or if you are working on something, then notice a different issue, but your changes are not ready to be commited.
|
||||
|
||||
You download a new repo (called cloning) using `git clone <url to repo>`, or use your IDE (see below)
|
||||
|
||||
|
||||
## The art of Commits
|
||||
Many people, even EProg TAs (trust me, I asked one) would tell you that what you write as your *commit message* doesn't matter much.
|
||||
They'd be right that for EProg, it doesn't matter much, but if you work in a larger project yourself, or worse still, together with other people,
|
||||
They'd be right that for EProg it doesn't matter much, but if you work on a larger project yourself, or worse still, together with other people,
|
||||
writing proper commit messages is VERY important.
|
||||
|
||||
I myself have been doing it wrong for years and still am not doing it right in my summaries repo (because there it doesn't matter as much).
|
||||
I myself have been doing it wrong for years and still am not doing it right in my summaries repo (because there it doesn't matter as much and I am following a consistent style).
|
||||
|
||||
In early 2026 I have finally learned how to write proper commit messages,
|
||||
according to the [Conventional Commit V1.0.0 Specification](https://www.conventionalcommits.org/en/v1.0.0/#pecification).
|
||||
@@ -103,3 +104,11 @@ If you use an IDE, chances are that it has its own authentication manager.
|
||||
If you use the CLI, you can use `git-credential-manager` if you want to use HTTPS authentication,
|
||||
or you can create an SSH key using `ssh-keygen -f ~/.ssh/gitlab`, then copy the public key to your GitLab account's SSH key settings panel.
|
||||
This is much more secure.
|
||||
|
||||
|
||||
## Cloning
|
||||
The act of `cloning` for `git` is downloading a repo for use with the `git`.
|
||||
There are two primary means of cloning, either via HTTP(S) or SSH. Whenever possible, SSH should be used due to it being a lot more secure.
|
||||
Set up authentication as mentioned above, then the clone URL is of the form `git@<git service host>:<repo owner>/<repo>`, e.g. `git@github.com:janishutz/eth-summaries`
|
||||
|
||||
For HTTP(S) cloning, it's simply the URL in the browser's address bar, e.g. `https://github.com/janishutz/eth-summaries`
|
||||
|
||||
Reference in New Issue
Block a user