Sanitizační kuchařka + jak přidat bug
import { Aside, Steps } from ‘@astrojs/starlight/components’;
1. Co se NIKDY nepíše (citlivá data)
Sekce “1. Co se NIKDY nepíše (citlivá data)”| Kategorie | Příklad zakázaného | Nahraď za |
|---|---|---|
| IP adresy, hostnames, porty | 203.0.113.10, db.example.com:5432 | <SERVER_IP>, „self-hosted server” |
| Hesla, klíče, tokeny, secrets | SMTP_PASS=…, sk_live_… | <SMTP_PASS>, <API_KEY> |
| Connection stringy | postgres://user:pass@host/db | „REST gateway nad Postgres” |
| Jména / e-maily klientů | „klient Jan N.”, jan@… | „klient”, „e-commerce projekt” |
| Názvy konkrétních firem | reálné obchodní jméno | obecný typ projektu |
| Identifikátory | IČO, DIČ, č. faktury, č. účtu | vynech úplně |
| Konkrétní názvy produktů/SKU | interní kódy | obecný popis |
2. Sanitizační kuchařka — krok za krokem
Sekce “2. Sanitizační kuchařka — krok za krokem”-
Abstrahuj incident na vzor. Ptej se: „jaký obecný technický problém to ilustruje?” Konkrétní firma/server/částka jsou pro poučení nepodstatné.
-
Nahraď konkrétní hodnoty placeholdery podle tabulky výše (
<SERVER_IP>,<API_KEY>, „platební brána” místo názvu, …). -
Generalizuj stack. Místo „Supabase na našem Hetzneru” napiš „self-hosted Postgres přes REST gateway (PostgREST)”. Verze a vendor jen pokud jsou pro bug podstatné.
-
Projdi code snippety. Odstraň reálné domény, ID, klíče, e-maily. Nech jen ilustrativní
foo,example.com,<TOKEN>. -
Závěrečná kontrola (grep): v celém záznamu nesmí zůstat: číslice vypadající jako IP, řetězce
sk_,pk_,Bearer,@(reálný e-mail),password,secret, reálné obchodní jméno. -
Test „je to užitečné cizímu člověku?” Pokud záznam dává smysl jen někomu, kdo zná konkrétní projekt → ještě jsi dostatečně neabstrahoval.
3. Jak přidat záznam (workflow pro bota i člověka)
Sekce “3. Jak přidat záznam (workflow pro bota i člověka)”-
Najdi/zvol kategorii (
deploy,payments,auth,database,frontend,monitoring,integrations,performance,security,ai-agents). -
Zkontroluj duplicitu — projdi existující záznamy v kategorii (nebo fetch
/llms-full.txt). Když už podobný existuje, rozšiř ho, nezakládej nový. -
Vytvoř soubor
src/content/docs/<kategorie>/<kebab-case-nazev>.mdpodle šablony. -
Vyplň frontmatter i tělo (Symptom → Root cause → Fix → Jak se vyvarovat → Sister bugs).
-
Projdi sanitizační kuchařku z bodu 2. ← povinné, bez výjimky.
-
Commit + push do větve
main:Terminál cd ~/Projects/tools/bug-wikigit add src/content/docs/<kategorie>/<soubor>.mdgit commit -m "bug(<kategorie>): <krátký popis>"git push -
GitHub Action web sám přebuduje a nasadí (~30 s). Hotovo.
4. Checklist před commitem
Sekce “4. Checklist před commitem”- Frontmatter má
title,description,category,severity,status,date,prevention. - Tělo má všechny sekce ze šablony.
- Prošel jsem sanitizační kuchařku (bod 2). Žádné IP / secrets / klienti / firmy.
- Záznam dává smysl i bez znalosti konkrétního projektu.
- Soubor je ve správné kategorii, název je kebab-case.