Hoppa till innehållet

Lät fyra repon följa en och samma historikstandard — konventionella commits, fria från emojier, utan attributionsrader, upprätthållen av en hook för commit‑meddelanden — vid sidan av 48 instruktionsdokument som styr hur arbetet utförs.

48 instruktionsdokument som styr hur arbetet utförs

Situation. Fyra repon byggda under arton månader av en enda person är det läge där process är lättast att hoppa över, eftersom det inte finns någon att samordna med och kostnaden för en oläslig historik betalas helt av ett framtida jag som ännu inte har klagat. Det är också det läge där en inkonsekvent historik är mest sannolik, eftersom varje repo kan glida in i sina egna vanor utan att något drar dem samman.

Uppgift. En standard för historik och en standard för instruktioner måste gälla i varje repo som arbetet skrivs i, och den måste upprätthållas maskinellt i stället för att man ska komma ihåg den.

Handling. Commitstandarden är ett konventionellt prefix som anger typen av ändring och ett scope, en ämnesrad under en fast längd, inga emojier och inga tillskrivningsrader av något slag — det sista eftersom en rad som krediterar ett verktyg inte är ett faktum om ändringen, och historiken är till för fakta om ändringar. En hook för commitmeddelanden avvisar allt som inte följer standarden, i varje repo där arbete sker, så standarden är en egenskap hos repot snarare än hos den som committar. Fördelningen i det största repot visar vad arbetet faktiskt var: 156 commits för funktioner, 133 rättningar, 128 för dokumentation, 81 för underhållssysslor, 26 refaktoreringar, 20 för stil, 5 för prestanda och 3 för test. Dokumentationen ligger så nära rättningarna att det är värt att notera, och det är en följd av den andra halvan av det här — 48 instruktionsdokument i de fyra repona, vart och ett täcker en domän, vart och ett är skrivet som regler snarare än beskrivning, och alla nås från ett enda ingångsdokument per repo så att det finns ett ställe att börja på. Ett lintverktyg för dokumentation upprätthåller storleksbudgetar per fil och indexmedlemskap, så att samlingen förblir navigerbar i stället för att växa till ett arkiv.

Resultat. Fyra repon delar ett historikformat och en instruktionsstruktur, båda upprätthållna av hookar snarare än av disciplin. Det som detta inte gör är att göra historiken bra: formatet kontrolleras men innehållet gör det inte, så en ämnesrad som följer standarden men inte beskriver någonting passerar precis lika väl som en som förklarar ändringen.

En del av en längre historik — och den finns i sin helhet här.

Varje post är skriven på samma sätt: situationen, uppgiften, vad vi gjorde och vad som förändrades.

Se hela historiken