Přeskočit na obsah

A406 — Anatomie pull requestu

Co má návrh změny obsahovat, aby ho šlo posoudit: rozsah, odůvodnění, doklad zelené brány a rozdíl, který se dá přečíst.

A406Příspěvky 10 minRešeršistaVývojář

Po téhle lekci

  • Sestavíte pull request s jedním tématem a čitelným rozdílem.
  • Doložíte, že brána prošla, ještě než ji spustí někdo jiný.
  • Vysvětlíte, proč se generované soubory neupravují ručně.

Pull request je návrh změny. Posuzuje se jako rozdíl, takže všechno, co rozdíl znečistí, zdrží schválení.

Jedno téma na jeden návrh

Oprava data u zdroje a přeformulování tří tvrzení jsou dvě různé věci. Když jsou v jednom návrhu, musí se schválit nebo zamítnout dohromady — a to znamená, že se nezamítne ani jedno, dokud se nevyřeší obojí.

Co má obsahovat

  • Co se mění a proč. Ne co je v rozdílu vidět, ale co to řeší.
  • Doklad, když jde o obsah — odkaz na zdroj, který změnu odůvodňuje.
  • Výsledek brány. Že jste ji spustili sami, než jste odeslali.

Brána

Kanonická brána projektu je jeden příkaz:

npm run build

Není to jen sestavení webu — projde jím validace kanonických dat, testy, kontrola autorizací, linty, generátory, sestavení a po něm ověření odkazů, strukturovaných dat, metadat a exportů. Musí skončit s kódem 0.

Pro rychlou kontrolu bez generování existuje:

npm run check

A pro ověření jednoho záznamu při psaní:

npm run data:validate

Ověř si, že to sedí

Váš pull request mění jedno tvrzení, ale v rozdílu je 40 změněných souborů. Co se stalo?

Zobrazit odpověď

Skoro jistě jste spustili sestavení a přidali do návrhu i regenerované výstupy.

Kanonická změna je jeden soubor v data/dossiers/**. Z něj se generují adaptéry v content/, přehledy, exporty a reporty. Část z nich je záměrně mimo verzování, část ne — a hromadné přidání toho zbytku udělá z jednoduchého návrhu nečitelný rozdíl.

Postup: nechte v návrhu kanonickou změnu a ty generované soubory, které se podle konvence repozitáře commitují (u dossierů jsou to adaptéry v content/). Zbytek vraťte.

A ověřte, že jste opravdu needitovali generovanou stránku místo dat — tenhle příznak často znamená právě to.

Kanonické znění pojmů

Lekce pojem vysvětluje. Závazná definice je tady — když se rozejdou, platí tahle stránka.