Ein ausfuehrliches deutschsprachiges Nachschlagewerk, mit dem ein Programmierprojekt auf GitHub sauber, verstaendlich und professionell praesentiert werden kann. Das Repository erklaert Struktur, README-Aufbau, wichtige Git-Befehle, Branching, Pull Requests, Releases und GitHub Pages.
Viele Projekte funktionieren technisch, wirken auf GitHub aber unaufgeraeumt. Dieses Repository ist als persoenliche Vorlage gedacht: Wenn ein neues Projekt entsteht, kann man hier nachschauen, welche Dateien wichtig sind, welche Git-Befehle man braucht und wie eine GitHub-Pages-Seite daraus wird.
Meine eigene Grundregel: Ein fremder Besucher soll nach ungefaehr einer Minute wissen, was das Projekt macht, wie man es startet und wo die wichtigsten Dateien liegen.
Der Leitfaden beantwortet besonders diese Fragen:
- Wie sieht eine klare Ordnerstruktur fuer ein Programmierprojekt aus?
- Welche Dateien gehoeren in den Root eines Repositories?
- Welche Git-Befehle brauche ich im Alltag wirklich?
- Wie arbeitet man mit Branches, Commits, Pull Requests und Releases?
- Wie schreibt man ein README, das Besucher schnell verstehen?
- Wie richtet man GitHub Pages fuer eine schoene Projektseite ein?
- Wie dokumentiert man ein Projekt so, dass man es spaeter selbst wieder versteht?
# 1. Neues Projekt anlegen
mkdir mein-projekt
cd mein-projekt
git init
# 2. Erste sinnvolle Dateien erstellen
touch README.md
touch .gitignore
mkdir src docs tests assets
# 3. Ersten Commit schreiben
git add .
git commit -m "Initial project structure"
# 4. Mit GitHub verbinden
git branch -M main
git remote add origin https://github.com/USERNAME/mein-projekt.git
git push -u origin main
mein-projekt/
|-- README.md
|-- LICENSE
|-- .gitignore
|-- index.html
|-- styles.css
|-- src/
|-- tests/
|-- docs/
|-- assets/
|-- examples/
|-- scripts/
`-- .github/
|-- workflows/
|-- ISSUE_TEMPLATE/
`-- PULL_REQUEST_TEMPLATE.md
Eine gute Struktur trennt Code, Dokumentation, Tests, Medien und GitHub-Konfiguration. Dadurch koennen Besucher schneller verstehen, wie das Projekt funktioniert, und du findest deine eigenen Dateien auch Monate spaeter wieder.
| Kapitel | Inhalt |
|---|---|
| 01 Repository-Struktur | Aufbau, Ordner, Root-Dateien und Namensregeln |
| 02 Git-Befehle | Die wichtigsten Befehle mit Erklaerung und Beispielen |
| 03 GitHub-Workflow | Branches, Issues, Pull Requests, Releases und Tags |
| 04 README und Dokumentation | Aufbau einer starken Projektpraesentation |
| 05 GitHub Pages | Projektseite, Deployment, Actions und Fehlerbehebung |
| 06 Checklisten | Prueflisten fuer Start, Push, Release und Pflege |
Zusaetzlich sammelt REPO_METADATA.md konkrete GitHub-Einstellungen wie Beschreibung, Topics, Homepage und Social Preview.
git status # Aktuellen Zustand ansehen
git add README.md # Datei vormerken
git add . # Alle Aenderungen vormerken
git commit -m "Message" # Commit erstellen
git log --oneline --graph # Verlauf kompakt ansehen
git branch feature/name # Branch erstellen
git switch feature/name # Branch wechseln
git merge feature/name # Branch zusammenfuehren
git pull # Aenderungen von GitHub holen
git push # Eigene Commits hochladen
git stash # Arbeit kurz parken
git tag v1.0.0 # Version markierenMehr Details stehen im Kapitel Git-Befehle.
Dieses Repository enthaelt eine fertige statische Projektseite:
index.htmlist die Startseite.styles.cssenthaelt das dunkle technische Design.script.jssteuert kleine Interaktionen..github/workflows/deploy-pages.ymlbeschreibt ein Deployment ueber GitHub Actions.
Nach dem Push zu GitHub kann Pages ueber Settings -> Pages aktiviert werden. Wenn GitHub Actions genutzt wird, sollte als Quelle GitHub Actions ausgewaehlt werden.
- Idee als Issue oder Notiz erfassen.
- Branch mit sprechendem Namen erstellen.
- Kleine, nachvollziehbare Commits schreiben.
- README und Docs zusammen mit dem Code aktualisieren.
- Pull Request oeffnen und Aenderungen pruefen.
- Nach dem Merge optional Release und GitHub Pages aktualisieren.
Im Ordner templates liegen kopierbare Vorlagen:
Diese Vorlagen sind bewusst allgemein gehalten und koennen fuer Webprojekte, Libraries, CLI-Tools oder Lernprojekte angepasst werden.
Ein gutes GitHub-Repository erklaert nicht nur den Code. Es erklaert, warum das Projekt existiert, wie man es startet, wie es aufgebaut ist und wie man daran weiterarbeitet.