From 12ce6e177f9e9d8e08e07110a747f90204acb7c4 Mon Sep 17 00:00:00 2001 From: jzitnik-dev Date: Tue, 17 Mar 2026 12:33:14 +0100 Subject: [PATCH] chore: Minor refinements --- CONTRIBUTING.md | 2 + server.ts | 8 ++-- web/content/posts/api/v3/index.md | 4 +- web/content/posts/contributing/index.md | 44 +++++++++++++++++++ .../posts/scraper-documentation/index.md | 4 ++ 5 files changed, 56 insertions(+), 6 deletions(-) create mode 100644 web/content/posts/contributing/index.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 71d707e..e8f9c15 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,3 +1,5 @@ +[This same exact file is also in web/content/posts. DO NOT FORGET TO EDIT THAT FILE TOO after editing this one.]: # + # Contributing Děkuji za váš zájem přispět do tohoto projektu. diff --git a/server.ts b/server.ts index 9c7812c..fff47cf 100644 --- a/server.ts +++ b/server.ts @@ -84,10 +84,6 @@ app.get("/status", async (_: Request, res: Response) => { } }) -app.get("/posts/viewer/redirect", (_: Request, res: Response) => { - res.redirect(302, "/viewer"); -}) - app.post("/report", async (req: Request, res: Response): Promise => { const { class: className, location, content } = req.body; if (!className || !location || !content) { @@ -145,6 +141,10 @@ if (SERVE_WEB) { return handle(req, res) }) + app.get("/posts/viewer/redirect", (_: Request, res: Response) => { + res.redirect(302, "/viewer"); + }) + app.use(express.static(path.join(process.cwd(), 'web/public'), { index: 'index.html', extensions: ['html'], diff --git a/web/content/posts/api/v3/index.md b/web/content/posts/api/v3/index.md index 9d75f4f..9f85bf8 100644 --- a/web/content/posts/api/v3/index.md +++ b/web/content/posts/api/v3/index.md @@ -5,11 +5,11 @@ tags: ["api", "docs", "v2"] hiddenInHomelist: true --- -Tato stránka detailně popisuje **Verzi 2 (v2)** API Ječná Rozvrh. +Tato stránka detailně popisuje **Verzi 3 (v3)** API Ječná Rozvrh. ## Endpoint: `GET /versioned/v3` -Toto je hlavní endpoint, který poskytuje veškerá data o rozvrhu pro v2. +Toto je hlavní endpoint, který poskytuje veškerá data o rozvrhu pro v3. ### Struktura Odpovědi diff --git a/web/content/posts/contributing/index.md b/web/content/posts/contributing/index.md new file mode 100644 index 0000000..fb3ba2d --- /dev/null +++ b/web/content/posts/contributing/index.md @@ -0,0 +1,44 @@ +--- +title: "Přispívání do projektu" +date: 2026-03-17 +tags: ["code", "contribution"] +hiddenInHomelist: true +--- + +# Contributing + +Děkuji za váš zájem přispět do tohoto projektu. +Příspěvky jsou vítány, ale **přijímám je pouze e-mailem ve formě `.patch` souborů**. + +## Jak přispět + +1. Naklonujte repozitář. +2. Vytvořte změny ve vlastní větvi. +3. Vygenerujte patch pomocí `git format-patch`. + +Například pro poslední commit: + +```bash +git format-patch -1 +``` + +Nebo pro změny vůči main: + +```bash +git format-patch origin/main +``` + +4. Vzniklý .patch soubor pošlete jako přílohu na: + +email@jzitnik.dev + +# Požadavky na patch +- patch musí být generovaný pomocí git format-patch +- změny musí být jasně popsané v commit message +- jeden patch by měl řešit jednu logickou změnu +- patch musí být aplikovatelný bez konfliktů + +# Co se stane potom +- patch zkontroluji +- pokud bude potřeba něco upravit, odpovím e-mailem +- po schválení patch aplikuji do repozitáře diff --git a/web/content/posts/scraper-documentation/index.md b/web/content/posts/scraper-documentation/index.md index ea1a6d8..88a6334 100644 --- a/web/content/posts/scraper-documentation/index.md +++ b/web/content/posts/scraper-documentation/index.md @@ -12,3 +12,7 @@ Celý proces je automatizovaný a běží v pravidelných intervalech, které se 3. **Generování JSONu:** Všechna přečtená a zpracovaná data jsou následně uložena do jednoho souboru ve formátu JSON. 4. **Poskytnutí přes API:** Tento JSON soubor je finálním zdrojem dat, který API server používá. + +--- + +[Kontribuce](/posts/contributing)