Jak zorganizovat verzování kódu při více knihovnách

Přispívání do open source projektů není jen o psaní kódu. Mnoho lidí si myslí, že musí být zkušený programátor, aby mohl pomoci. Opak je pravdou – projekty potřebují dokumentaci, testování, překlady, návrhy uživatelského rozhraní nebo správu komunit. Pokud chcete začít, prvním krokem je vybrat si projekt, který reálně používáte nebo který vás zaujme. Prohlédněte si jeho repozitář a zjistěte, jaká je struktura souborů, kde jsou diskuze a jakým způsobem se řeší úkoly. Většina zavedených projektů má v popisu sekci s pokyny pro přispěvatele – to je základní dokument, který byste měli přečíst dřív, než cokoliv uděláte.

Další věc, na kterou začátečníci často narazí, je git status. Tento příkaz ukazuje, co se ve vašem projektu děje: které soubory jsou upravené, které přidané a které ještě nejsou sledované. Berte ho jako svou GPS – spouštějte ho po každém větším kroku. Nebojte se ani git log, který vypíše historii commitů s daty a autory. Tyto dva příkazy byste měli používat častěji než samotný commit, protože vám dají zpětnou vazbu o stavu vaší práce.

Začněte analýzou stávajícího schématu. MySQL často používá typy jako TINYINT, ENUM nebo AUTO_INCREMENT, které v PostgreSQL nemají přímý ekvivalent. V PostgreSQL použijte typ SMALLINT pro TINYINT, ENUM lze nahradit typem VARCHAR s CHECK omezením nebo nativním typem ENUM (ale jen pokud si uvědomíte jeho omezení při přidávání hodnot). AUTO_INCREMENT se transformuje na SERIAL nebo GENERATED AS IDENTITY – druhá varianta je modernější a doporučovaná. Dávejte pozor také na rozdíly v práci s řetězci: v MySQL je porovnání obvykle case-insensitive, v PostgreSQL záleží na collation, takže budete muset použít ILIKE nebo citext.

Jak strukturu přetavit v akci Nejdůležitější část přichází po identifikaci problému. Každý podnět musí dostat odpovědného vlastníka a konkrétní termín. Například pokud tým narazí na nejasnosti v zadání, určete jednoho člověka, který do pěti dnů připraví novou šablonu zadání. Nestačí říct „domluvíme se" – to je cesta k tomu, že se za dva týdny vrátíte ke stejnému problému. Na konci retrospektivy si vyberte maximálně tři akční kroky, jinak se tým zahltí a nic se neudělá.

Pamatujte také na to, že open source je o spolupráci, ne o soutěži. Neberte si kritiku osobně – code review je standardní součástí procesu. Když vám někdo navrhne změny, snažte se je pochopit a zdvořile na ně reagovat. Pokud nesouhlasíte, vysvětlete proč, ale buďte připraveni diskutovat. Dobrým zvykem je poděkovat recenzentovi za čas.

Nakonec pamatujte, že verzování není jen o číslech, ale o komunikaci. Nezavádějte příliš mnoho verzí najednou. Pokud je to možné, udržujte jednu hlavní verzi knihovny a pro starší verze vytvářejte jen bezpečnostní opravy. U projektů s více verzemi knihoven pak vždy definujte, která verze je oficiální pro produkci a která je určena pro experimenty. Tím se vyhnete zmatkům a všichni budou vědět, na čem staví.

Mezi nejčastější chyby patří zapomenutí na hlavičky, nesprávný formát těla požadavku nebo neuvědomění si rozdílu mezi GET a POST. U POST vždy nastavte hlavičku Content-Type na application/json a tělo zadejte v surovém formátu. Dále pozor na citlivé údaje – nikdy neukládejte hesla do proměnných, které sdílíte s týmem. Pro citlivá data použijte proměnné s hodnotami, které se nenačítají ze souboru. Postman je mocný nástroj, ale vyžaduje disciplínu. Pokud se naučíte strukturovat kolekce, používat proměnné a psát smysluplné testy, ušetříte si spoustu času a předejdete chybám v produkci.

Dalším častým problémem je rychlý skok k řešení dřív, než je problém dobře pochopen. Když se objeví podnět typu „pravidelně nám padá testovací prostředí", zeptejte se „jak často", „kdy" a „co to způsobuje". Teprve s fakty můžete navrhnout smysluplné opatření. Pokud nemáte data, klidně si naplánujte, že příští sprint budete sledovat četnost výpadků a podle toho se rozhodnete. Strukturovaná zpětná vazba totiž není o rychlých opravách, ale o tom, abyste příště dělali méně chyb.

Pro ověření správnosti odpovědí slouží testy. V záložce Tests píšete JavaScriptový kód. Například pro kontrolu status kódu použijete příkaz pm.response.to.have.status(200). Testy můžete psát i pro kontrolu obsahu, délky, typu dat či přítomnosti hlaviček. Typickou chybou začátečníků je testovat pouze status kód, ale zapomenout na obsah. Přitom API může vrátit kód 200, ale tělo obsahuje chybovou hlášku. Proto vždy kombinujte více kontrol.

Postman patří mezi nejrozšířenější nástroje pro práci s API. Umožňuje posílat požadavky na server, zkoumat odpovědi a celý životní cyklus API dokumentovat. Než začnete, stáhněte si desktopovou aplikaci nebo použijte webovou verzi. Po spuštění vytvořte novou kolekci – ta slouží jako úložiště pro vaše požadavky, proměnné a testy. Kolekce je vhodné pojmenovat podle projektu, aby se v ní vyznali i kolegové.