From bf6743e24336956471f76fbba5b75efc408f9414 Mon Sep 17 00:00:00 2001 From: p1ng0ut Date: Wed, 24 Apr 2024 19:26:16 +0200 Subject: [PATCH] feature/ordnerstruktur (#2) Co-authored-by: axiomer <> Reviewed-on: https://git.dezentrale.cloud/Buendnis_Privatsphaere_Leipzig/Folien/pulls/2 --- README.md | 35 ++++++++++++++++++++++++++++++++++- 1 file changed, 34 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index bc4b212..b6a98ed 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,36 @@ # Folien -Foliensätze für Cryptoparties, Workshops u.ä. \ No newline at end of file +Foliensätze für Informationsveranstaltungen zum Thema Datenschutz und Privatsphäre. Insbesondere sollen sie +dazu dienen Hands-On-Workshops (sog. Cryptoparties) zu veranstalten. + +## Mitarbeiten + +### Branch-Struktur + +Das Repository hat einen `main`-Branch der stets die aktuelle Version der Folien enthält. Der `main`-Branch ist +geschützt, das heißt es kann nicht direkt auf den `main`-Branch gepusht werden. Änderungen können wie folgt +vorgenommen werden: + +- Erstelle einen neuen Branch mit einem sprechenden Namen (z. B. `neue-folien`) und wechsle auf diesen Branch +- Mache deine Änderungen +- Pushe deine Änderungen zum Git-Server +- Erstelle einen Pull-Request von deinem Branch zum `main`-Branch +- Benachrichtige eine andere Person aus der Gruppe, damit sie deinen Pull-Request prüft und ggf. merged + +### Ordnerstruktur + +Das Repository hat die folgende Struktur: + +``` +. ++- index.html -- Startseite mit Übersicht über alle Foliensätze ++- [_template] -- enthält das Template für neue Foliensätze ++- [mein-thema] -- enthält Foliensatz zum jeweiligen Thema ++ +- index.html -- HTML-Datei für Anzeige der Folien ++ +- slides.md -- Markdown-Datei mit Inhalt der Folien +``` + +### Namenskonvention + +Der Name des Ordners sollte das Thema des Foliensatzes in 1-3 Worten beschreiben. Der Name sollte klein geschrieben +und Worte durch Minuszeichen getrennt werden, z. B. "verschluesselung-mit-gpg".