REST API v Node.js a Express, o kterém většina zapomíná
More actions
Při práci na více větvích souběžně je klíčové časté slučování hlavní větve do vaší feature větve. Nečekejte až na konec, ale průběžně si do své větve natáhněte nejnovější změny od kolegů. Tím minimalizujete rozsah konfliktů, protože rozdíly mezi větvemi řešíte po malých dávkách. Mějte na paměti, že konflikt při sloučení není chyba, ale běžná součást práce. Když k němu dojde, otevřete dotčené soubory a rozhodněte, kterou verzi zachováte. Pravidlem je nespěchat a vždy si přečíst obě strany změny, abyste neztratili důležitou logiku.
Nejdůležitější je pochopit, jak pytest spouští jednotlivé testy. Spuštění provedete příkazem pytest v adresáři s testy. Pytest sám prohledá aktuální složku a podsložky a najde soubory odpovídající konvenci. Když chcete spustit jen jeden soubor, napíšete pytest test_math.py. Pro konkrétní test použijete pytest test_math.py::test_plus. Tento zápis je užitečný, když máte mnoho testů a chcete rychle ověřit jeden z nich.
Jak se vyhnout typickým chybám při prvním příspěvku Nejčastějším problémem je ignorování pokynů pro styl kódu a formátování. Každý projekt má vlastní pravidla, často definovaná v konfiguračních souborech pro linter nebo ve stylistické příručce. Před odesláním pull requestu si projděte, jestli váš kód splňuje tyto standardy. Další chybou je nedostatečné testování – neposílejte změny, které jste nezkusili na vlastním prostředí. Pokud přidáváte novou funkci, napište pro ni testy. To nejen zvýší šanci na přijetí, ale také vám pomůže odhalit vlastní chyby.
Častým nešvarem je práce na více feature větvích z jednoho lokálního klonu bez přepínání mezi nimi. Pokud máte rozjeté tři větve a v každé děláte něco jiného, snadno se stane, že začnete commitovat změny do nesprávné větve. Řešením je buď používat samostatné pracovní adresáře pro každou větev, nebo důsledně kontrolovat aktuální větev před každým commitem a pull requestem. Mnoho vývojářů si také plete stav v lokálním úložišti se stavem na vzdáleném serveru. Než začnete novou práci, vždy si stáhněte nejnovější změny a porovnejte, jestli vaše lokální větev odpovídá té vzdálené.
Při komunikaci s maintainery buďte trpěliví a respektujte jejich čas. Nemusí odpovědět hned, a pokud váš příspěvek vyžaduje úpravy, berte to jako standardní součást procesu. Vyhněte se pasivně-agresivním poznámkám a osobním útokům, i když s rozhodnutím nesouhlasíte. Zdvořile vysvětlete své důvody a nabídněte kompromis. Nezapomeňte také na pravidlo, že jeden pull request by měl řešit jednu věc. Rozsáhlé změny, které kombinují refaktoring s novou funkcí, jsou obtížné k review a často končí uzavřené bez přijetí.
Jak si uspořádat workflow, aby vás větve nezahltily Před začátkem práce si vždy vytáhněte aktuální stav z hlavní větve a vytvořte novou větev z nejnovějšího commitu. Používejte výstižné názvy větví s číslem úkolu nebo krátkým popisem změny, třeba „feat/prihlasovani-formular" nebo „fix/oprava-ceny". Vyhnete se tak větvím s názvy jako „test" nebo „oprava2", které po týdnu nikdo nepřiřadí k žádnému úkolu. Zároveň si zvykněte na pravidelné commity s jasnými zprávami. Každý commit by měl obsahovat jednu logickou změnu a popis, co a proč se mění. Vyhnete se tak situaci, kdy v jednom commitu opravujete chybu i přidáváte novou funkci, což ztěžuje zpětnou kontrolu a reverty.
def zakaznik():
Přínos z přispívání není jen o tom, že projekt získá novou funkci. Vy sami se naučíte číst cizí kód, s verzovacími nástroji a komunikovat s lidmi z různých prostředí. Tyto dovednosti se hodí v profesním životě, ať už pracujete jako vývojář, nebo v jiné roli. Pravidelnou účastí si také vybudujete reputaci, která vám může otevřít dveře k dalším příležitostem. Takže neváhejte – vyberte si projekt, který používáte, a udělejte první rekonstrukce koupelny krok za krokem. I malá změna může mít velký dopad.
Při práci s databází se často zapomíná na validaci vstupů na úrovni API. Express sám o sobě žádnou validaci nenabízí, proto je vhodné použít nějakou knihovnu pro schémata. Pokud validaci podceníte, riskujete neočekávané chyby databáze, které se pak těžko debugují. úložné prostory v malém bytěždy si ověřte, že příchozí data odpovídají očekávanému typu a délce. A pokud narazíte na neplatný vstup, okamžitě vraťte 400 s konkrétní chybovou hláškou.
Druhým častým problémem je špatné používání HTTP stavových kódů. Mnoho vývojářů vrací při validační chybě kód 200 s chybovou hláškou v těle odpovědi. To je matoucí a porušuje to základy HTTP protokolu. rady pro rekonstrukci chybějící parametr použijte 400, pro neautorizovaný přístup 401 a pro zakázanou akci 403. Teprve když klient vidí správný stavový kód, může na chybu adekvátně reagovat. Navíc si snadno nastavíte logger, který zaznamená všechny 4xx a 5xx odpovědi pro pozdější analýzu.