Hüppa sisule
1 min lugemist

Miks ma pean CHANGELOG.md faili üksinda

Fail ühe-inimese-publiku jaoks ja miks sellest on saanud repo kõige kasulikum fail.

Sisukord
  1. Mis selles on
  2. Mille jaoks see on
  3. Milleks see on saanud

Igas repos, mis mulle kuulub, on CHANGELOG.md, sealhulgas need, mille ainsana ma kunagi lugema saan. Olen seda teinud kaks aastat. See on üks väheseid harjumusi, mille meeles pidamist ma enam ei pea endale meelde tuletama.

Mis selles on#

Üks kanne päeva kohta, mil ma projekti puudutan. Kolm rida, minevikuvormis. Mis ma välja saatsin, mis ma katki tegin, mille ma täna otsustasin mitte teha. Kuupäevad kahanevas järjekorras. Mingeid uhkeid kategooriaid. Mingit malli. Mingit tööriistakomplekti.

"Kolm rida" piirang on see, mis hoiab faili elus. Pikem vorm oleks hüljatud kolmandaks nädalaks.

Mille jaoks see on#

Tuleviku-mina, mingil teisipäeval kolme kuu pärast, küsides, miks mingi koodijupp nii välja näeb. Git'i logi vastab, mis muutus. Changelog vastab, miks. Need kaks koos on vahe mineviku-mina usaldamise ja mineviku-mina mitteusaldamise vahel.

Mitteusaldamise juhtum on kallis. Olen kulutanud päevi otsuse uuesti tuletamiseks, mille olin juba teinud, kuna originaalist polnud ühtegi salvestust ellu jäänud.

Milleks see on saanud#

Päevik projektide jaoks, kirjutatud tehnilises hääles. Märkmiku projekti- versioon. Ma ei näita seda kellelegi. Ma ei optimeeri seda jagamiseks. Asjaolu, et keegi seda kunagi ei näe, teeb selle ausaks.

Jaga seda postitust
Seotud märkmed