Skip to content

Commit ce4cb17

Browse files
author
dgodglue
committed
docs: extends docs with best practices
1 parent 45ba62b commit ce4cb17

File tree

1 file changed

+33
-7
lines changed

1 file changed

+33
-7
lines changed

README.md

Lines changed: 33 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,41 @@ Dieses Repository dient dazu, sich mit Git-Befehlen und GitHub-Features vertraut
1414
## 🚀 Nützliche Git-Befehle
1515

1616
```bash
17-
git clone # Repository klonen
18-
git status # Aktueller Status
19-
git add . # Alle Änderungen hinzufügen
20-
git add <file> # Spezifische Änderungen hinzufügen
21-
git commit -m "Message" # Commit erstellen
22-
git pull # Änderungen holen und (default) HEAD mergen
23-
git push # Zum Remote-Repository pushen
17+
git clone # Repository klonen
18+
git checkout -b <branch> # Erstellen eines Zweig-Branches aus dem aktuell ausgecheckten Branch
19+
git status # Aktueller Status
20+
git add . # Alle Änderungen hinzufügen
21+
git add <file> # Spezifische Änderungen hinzufügen
22+
git commit -m "Message" # Commit erstellen
23+
git pull # Änderungen holen und (default) HEAD mergen
24+
git push # Zum Remote-Repository pushen
2425
```
2526

27+
## ✅ Best Practices
28+
Um die Zusammenarbeit im Team zu optimieren, ist die Anwendung sogenannter Best Practices unerlässlich.
29+
Deren konsequente Einhaltung steigert erheblich die Nachvollziehbarkeit der Änderungen, sowie die Wartbarkeit
30+
und dadurch maßgeblich die Qualität der Software. Folgende Empfehlungen haben sich etabliert:
31+
32+
- Tickernummern müssen im Branch-Namen erkenntlich sein
33+
- origin/3050_main
34+
- Änderungen sollten in kleineren Commits dokumentiert werden
35+
- einheitliche und englischsprachige Commit-Nachrichten verwenden
36+
- Ticketnummer in eckigen Klammern und kurzer Titel des Tickets
37+
- Präfixe wie z.B. fix, feat, docs, usw. verwenden
38+
- Der Betreff sollte mit einem Großbuchstaben beginnen
39+
- regelmäßiges Synchronisieren des Forkes um Merge-Konflikte zu minimieren
40+
### Example commit-msg:
41+
```
42+
# [3050] Betreffzeile (max. 50 Zeichen)
43+
#
44+
# Längere Beschreibung mit 72 Zeichen pro Zeile (wrapped)
45+
# Kurz erklären warum die Änderungen gemacht wurden
46+
# und welche Auswirkungen diese haben
47+
#
48+
# Link zum Ticket kann hier optional eingefügt werden
49+
```
50+
51+
2652
## 🥳 Git Online Browser Game
2753
Wer ein paar Git Grundlagen lernen oder auffrischen möchte, für den ist folgendes
2854
Browser Online Game etwas. In diesem Spiel kann man Git in kleinen Schritten spielerisch lernen.

0 commit comments

Comments
 (0)