62 lines
2.1 KiB
Markdown
62 lines
2.1 KiB
Markdown
# Committen und Pushen einer Readme
|
||
|
||
## 1. Neue Datei erstellen
|
||
Erstelle eine neue Datei in deinem lokalen Repository mit dem Namen `README.md` und kopiere den folgenden Inhalt hinein:
|
||
```txt
|
||
# README.md Erklärung
|
||
|
||
Dies ist eine einfache README.md-Datei, die grundlegende Markdown-Syntax verwendet.
|
||
|
||
## Abschnitt 1: Überschrift
|
||
|
||
Das ist ein Abschnitt mit einer größeren Überschrift. Hier kannst du allgemeine Informationen zu deinem Projekt angeben.
|
||
|
||
## Abschnitt 2: Liste
|
||
- Dies ist der erste Punkt in einer Liste.
|
||
- Und hier ist ein weiterer Punkt in der Liste.
|
||
|
||
Du kannst auch nummerierte Listen verwenden:
|
||
1. Erster Schritt
|
||
2. Zweiter Schritt
|
||
```
|
||
|
||
## 2. Änderungen pullen (optional)
|
||
Falls du mit mehreren Entwicklern arbeitest, solltest du **IMMER** zuerst neue Änderungen aus dem Remote-Repository ziehen, um sicherzustellen, dass deine lokale Version aktuell ist und Konflikte vermieden werden. Falls du alleine arbeitest, kannst du diesen Schritt überspringen.
|
||
```bash
|
||
git pull
|
||
```
|
||
|
||
## 3. Datei stagen
|
||
Füge die Datei zur Staging Area hinzu, um sie für den Commit vorzubereiten. Wenn du nur die `README.md` Datei committen möchtest, ist es sicherer, dies explizit zu tun:
|
||
```bash
|
||
git add README.md
|
||
```
|
||
Wenn du jedoch alle Änderungen im aktuellen Verzeichnis stagen willst, kannst du auch diesen Befehl verwenden:
|
||
```bash
|
||
git add .
|
||
```
|
||
|
||
## 4. Commit erstellen
|
||
Committe die Datei mit einer klaren, aussagekräftigen Nachricht.
|
||
|
||
Eine gute Praxis ist es, die Nachricht in Englisch im Present Tense mit dem Format `type: description` zu schreiben.
|
||
|
||
Ein Beispiel für diese Übung wäre:
|
||
```bash
|
||
git commit -am "chore: Add README.md"
|
||
```
|
||
|
||
## 5. Änderungen pushen
|
||
Pushe deinen Commit ins Remote-Repository (z. B. Gitty, GitHub):
|
||
```bash
|
||
git push
|
||
```
|
||
|
||
## 6. Überprüfen
|
||
Besuche dein Repository im Webinterface und stelle sicher, dass die `README.md` Datei korrekt hochgeladen wurde und im Webinterface sichtbar ist. Der Link folgt diesem Schema:
|
||
```txt
|
||
https://gitty.informatik.hs-mannheim.de/<Matrikelnummer>/<Repository_Name>
|
||
```
|
||
Für dieses Repository z. B. ist es:
|
||
https://gitty.informatik.hs-mannheim.de/3002833/Git
|