Skip to content

Commit

Permalink
WIP add descriptions
Browse files Browse the repository at this point in the history
This will later be used as an explenation
  • Loading branch information
miallo committed Jan 2, 2024
1 parent 484b60a commit 9839ba1
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 0 deletions.
6 changes: 6 additions & 0 deletions src/wip_descriptions/advanced-nomenclature.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
# Advanced Concepts

- _Commit_\*: A commit is not in fact the set of changes, but a snapshot of the whole project at a time. This is the reason why git does not particularly want you to commit large binary files, because if a single bit is changed, git will store a whole new copy of the file.
- _Hash_: Not only commits have hashes
- _Porcelain_/_Plummbing_ commands: Porcelain commands are the one that a normal user would use (like `status`, `commit`, `log`, ... or in the real world analogy: the sink/toilet), so the high level ones. They themselves call the low level Plummbing commands in various combination to achieve the goal (real world: the toilet uses the plumbing to get fresh and get rid of the waste water). git provides you with them, in case you want/need to dig into some details, but for everyday use, you won't need them
-
3 changes: 3 additions & 0 deletions src/wip_descriptions/commit.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# What is a _Commit_?

The simplest view on commits is that they are a set of changes bundled together with a message
9 changes: 9 additions & 0 deletions src/wip_descriptions/simple-nomenclature.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Nomenclature

This is the simple way to describe commonly used words in git. For simplification reasons some definitions contain statements that are in fact wrong (noted with a "\*"), but helpful for a first understanding. Once you are comfortable with these I would recommend you to look into the [advanced nomenclature](./advanced-nomenclature.md). Also that contains more advanced concepts that you might come across later.

- _Commit_\*: a set of changes bundled together with a _Commit-Message_ describing what happened. Each commit has a unique _Hash_ that references it.
- _Commit-Message_: A string describing the changes of a commit. The first line of it is called the title and it is shown in many places. It should give a general idea on what was done and should not be longer than ~50 characters. If that is not enough, you can append an empty line and afterwards you are free to write
- _Hash_: a hexadecimal (= digits + letters from a-f) string that is up to 40 characters long. It is usually abbreviated to 8 characters, but can be truncated more or less, as long as there is no other hash that starts with the same characters.
- _Staging_\*: Preparing git to tell it which changes you want to bundle together in the next commit
- _Status_: overview of the current project state telling you

0 comments on commit 9839ba1

Please sign in to comment.