From 11fd5fd1728566b0477b9ae7f0ded44eb4af0bc0 Mon Sep 17 00:00:00 2001 From: shinya Date: Mon, 13 Oct 2025 12:22:09 +0200 Subject: [PATCH 1/6] Edited README --- README.md | 90 ++++++++++++++++++++++++++++++++++++++++++++++++++----- 1 file changed, 83 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 4580885..7dc5c11 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,90 @@ # Knihovna -## Jak přidávat vaši práci -- Vaše práce bude ve složce ./src a každá funkce bude implementována právě v jednom souboru. -- Definice samotných tabulek je v souboru Database.cs -- V souboru Program.cs je výsledek a výstup z celého projektu použitý +# 🧱 Jak přidávat vaši práci -- `git clone https://gitea.homework.zip/shinya/Knihovna.git` - Zkopírujte si projekt lokálně -- Vytvořte změny v projektu a následně je commitněte a pushněte zpět na server do podle instrukcí výše. -- Samotné zadání projektu pro jednotlivé týmy bude v adresáři ./docs kde se bude nacházet konkrétní specifikace projektu pro jednotlivé týmy +## 📂 Struktura projektu + +Projekt je organizován do několika klíčových částí: + +Knihovna/ +│ +├── src/ # Zdrojové soubory – zde bude vaše implementace +│ ├── Funkce1.cs +│ ├── Funkce2.cs +│ └── ... +│ +├── Database.cs # Definice databázových tabulek a datových modelů +│ +├── Program.cs # Hlavní vstupní bod programu (spuštění aplikace) +│ +└── docs/ # Dokumentace a zadání pro jednotlivé týmy +├── TymA.md +├── TymB.md +└── ... + +--- + +## Popis hlavních souborů + +### `./src/` +- Každá **funkce** nebo **část logiky** musí být implementována **v samostatném souboru**. +- Například funkci pro vyhledávání knih uložte do souboru `VyhledavaniKnih.cs`. +- Tento přístup zajišťuje přehlednost, modularitu a snadné testování. + +### `Database.cs` +- Obsahuje **definici tabulek** a **datových struktur**, které reprezentují databázi (např. `Knihy`, `Ctenari`, `Vypujcky`). +- Není vhodné měnit strukturu bez předchozí domluvy s ostatními členy týmu, protože soubor je sdílený v rámci celého projektu. + +### `Program.cs` +- Slouží jako **hlavní vstupní bod** aplikace. +- Zde se spouští program, načítají data a volají funkce z adresáře `src`. +- Tento soubor zajišťuje propojení všech částí projektu. + +--- + +## Postup při přidávání vaší práce + +### 1️⃣ Klonování repozitáře + +Stáhněte si projekt lokálně pomocí GITu: + +```bash +git clone https://gitea.homework.zip/shinya/Knihovna.git +``` +Tímto příkazem vytvoříte lokální kopii projektu na vašem počítači. + +## Úpravy a implementace +Vytvořte nebo upravte soubory v adresáři ./src/. + +Dodržujte strukturu projektu a konvence psaní kódu. + +Průběžně testujte své změny (např. pomocí dotnet run). + +## Commit a push +Jakmile máte změny hotové, proveďte následující příkazy: + +```bash +git add . +git commit -m "Implementace funkce vyhledávání knih" +git push +``` +Tímto nahrajete změny zpět na server. + +Pozor: Před odesláním změn vždy nejprve stáhněte aktuální verzi projektu: + +```bash +git pull +``` +- a vyřešte případné konflikty, pokud se vyskytnou. + +## Zadání projektů +V adresáři ./docs se nachází zadání pro jednotlivé týmy. +Každý tým má svůj vlastní soubor (např. TymA.md, TymB.md), který obsahuje: + +- konkrétní popis úkolu, +- technické požadavky, +- a případně hodnoticí kritéria. ## Info From 8c095470b6c5e1111e7b46505048509fbe3120f6 Mon Sep 17 00:00:00 2001 From: shinya Date: Mon, 13 Oct 2025 12:24:20 +0200 Subject: [PATCH 2/6] Edited README --- README.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 7dc5c11..3743c98 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@ # Knihovna +# Jak přidávat vaši práci -# 🧱 Jak přidávat vaši práci - -## 📂 Struktura projektu +## Struktura projektu Projekt je organizován do několika klíčových částí: +```shell Knihovna/ │ ├── src/ # Zdrojové soubory – zde bude vaše implementace @@ -22,6 +22,7 @@ Knihovna/ ├── TymA.md ├── TymB.md └── ... +``` --- @@ -108,7 +109,7 @@ Každý tým má svůj vlastní soubor (např. TymA.md, TymB.md), který obsahuj 1. Struktura databáze 2. Informace z databáze zpracování -3. +3. ## Funkce @@ -116,7 +117,7 @@ Každý tým má svůj vlastní soubor (např. TymA.md, TymB.md), který obsahuj - GetBooksByAuthor() param. filter - GetBooksByName() param. filter - GetStolenBooks() param. filter - - GetAvailableBooks() param. filter + - GetAvailableBooks() param. filter - GetBorrowedBooks() param. userID - GetBookInfo() param. knihaID - AddBook() param. KnihaInfo From 1239957baea621a946c2ecf48c3ef4311ed941c7 Mon Sep 17 00:00:00 2001 From: shinya Date: Mon, 13 Oct 2025 12:27:23 +0200 Subject: [PATCH 3/6] Edited README --- README.md | 21 ++++++++++++++------- 1 file changed, 14 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 3743c98..37734aa 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,5 @@ # Knihovna -# Jak přidávat vaši práci - ## Struktura projektu Projekt je organizován do několika klíčových částí: @@ -29,15 +27,18 @@ Knihovna/ ## Popis hlavních souborů ### `./src/` + - Každá **funkce** nebo **část logiky** musí být implementována **v samostatném souboru**. - Například funkci pro vyhledávání knih uložte do souboru `VyhledavaniKnih.cs`. - Tento přístup zajišťuje přehlednost, modularitu a snadné testování. ### `Database.cs` + - Obsahuje **definici tabulek** a **datových struktur**, které reprezentují databázi (např. `Knihy`, `Ctenari`, `Vypujcky`). - Není vhodné měnit strukturu bez předchozí domluvy s ostatními členy týmu, protože soubor je sdílený v rámci celého projektu. ### `Program.cs` + - Slouží jako **hlavní vstupní bod** aplikace. - Zde se spouští program, načítají data a volají funkce z adresáře `src`. - Tento soubor zajišťuje propojení všech částí projektu. @@ -46,16 +47,18 @@ Knihovna/ ## Postup při přidávání vaší práce -### 1️⃣ Klonování repozitáře +### Klonování repozitáře Stáhněte si projekt lokálně pomocí GITu: ```bash git clone https://gitea.homework.zip/shinya/Knihovna.git ``` + Tímto příkazem vytvoříte lokální kopii projektu na vašem počítači. ## Úpravy a implementace + Vytvořte nebo upravte soubory v adresáři ./src/. Dodržujte strukturu projektu a konvence psaní kódu. @@ -63,6 +66,7 @@ Dodržujte strukturu projektu a konvence psaní kódu. Průběžně testujte své změny (např. pomocí dotnet run). ## Commit a push + Jakmile máte změny hotové, proveďte následující příkazy: ```bash @@ -70,6 +74,7 @@ git add . git commit -m "Implementace funkce vyhledávání knih" git push ``` + Tímto nahrajete změny zpět na server. Pozor: Před odesláním změn vždy nejprve stáhněte aktuální verzi projektu: @@ -77,9 +82,11 @@ Pozor: Před odesláním změn vždy nejprve stáhněte aktuální verzi projekt ```bash git pull ``` + - a vyřešte případné konflikty, pokud se vyskytnou. ## Zadání projektů + V adresáři ./docs se nachází zadání pro jednotlivé týmy. Každý tým má svůj vlastní soubor (např. TymA.md, TymB.md), který obsahuje: @@ -114,10 +121,10 @@ Každý tým má svůj vlastní soubor (např. TymA.md, TymB.md), který obsahuj ## Funkce - GetBooks() param. filter wrapper function, pick if by name or author - - GetBooksByAuthor() param. filter - - GetBooksByName() param. filter - - GetStolenBooks() param. filter - - GetAvailableBooks() param. filter + - GetBooksByAuthor() param. filter + - GetBooksByName() param. filter + - GetStolenBooks() param. filter + - GetAvailableBooks() param. filter - GetBorrowedBooks() param. userID - GetBookInfo() param. knihaID - AddBook() param. KnihaInfo From 9d7872dfd6465e3d7bb7ea02c3f577c60cf548ac Mon Sep 17 00:00:00 2001 From: shinya Date: Mon, 13 Oct 2025 12:30:47 +0200 Subject: [PATCH 4/6] Edited README --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 37734aa..c4d0cb4 100644 --- a/README.md +++ b/README.md @@ -32,6 +32,9 @@ Knihovna/ - Například funkci pro vyhledávání knih uložte do souboru `VyhledavaniKnih.cs`. - Tento přístup zajišťuje přehlednost, modularitu a snadné testování. +> [!IMPORTANT] +> Všechny proměnné se pojmenovávají v angličtině ve stylu CamelCase, to stejné platí pro názvy souborů. + ### `Database.cs` - Obsahuje **definici tabulek** a **datových struktur**, které reprezentují databázi (např. `Knihy`, `Ctenari`, `Vypujcky`). From b4ceb3f9a5b74170262f3d1cef307227ca0f52f2 Mon Sep 17 00:00:00 2001 From: haterdotdev Date: Mon, 20 Oct 2025 08:24:34 +0000 Subject: [PATCH 5/6] Update chore(docs): conventional commits req --- README.md => chore(docs): conventional commits req | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) rename README.md => chore(docs): conventional commits req (96%) diff --git a/README.md b/chore(docs): conventional commits req similarity index 96% rename from README.md rename to chore(docs): conventional commits req index c4d0cb4..26750bd 100644 --- a/README.md +++ b/chore(docs): conventional commits req @@ -71,10 +71,12 @@ Průběžně testujte své změny (např. pomocí dotnet run). ## Commit a push Jakmile máte změny hotové, proveďte následující příkazy: +Dodržujte conventional commits: +https://www.conventionalcommits.org/en/v1.0.0/ ```bash git add . -git commit -m "Implementace funkce vyhledávání knih" +git commit -m "feat: funkce vyhledávání knih" git push ``` From 37cb7273ab03e02e66c4ab7c87d77829db97762c Mon Sep 17 00:00:00 2001 From: haterdotdev Date: Mon, 20 Oct 2025 08:25:31 +0000 Subject: [PATCH 6/6] Update README.md --- chore(docs): conventional commits req => README.md | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename chore(docs): conventional commits req => README.md (100%) diff --git a/chore(docs): conventional commits req b/README.md similarity index 100% rename from chore(docs): conventional commits req rename to README.md