Přeskočit na obsah

Tato stránka byla automaticky přeložena z angličtiny, jediného jazyka, ve kterém se tento web píše. Číst originál.

První hodina v repozitáři, který nikdo nedokáže rychle vysvětlit

Co je v kódové základně konvencí, je znalost držená stálými členy, takže každý příchozí — člověk i stroj — za ni platí znovu.

→ strávil první hodinu v neznámém repozitáři zjišťováním, co je tu normální

cena, když k tomu dojde
střední
jak často
konstanta
oblast
kontext

Okamžik

Schopný inženýr, nebo schopný worker, dostane repozitář a úkol změnit něco malého. Změna zabere deset minut. Zjistit, co je tu normální — rozvržení, konvence, věci, které vypadají špatně a jsou záměrné — zabere zbytek dopoledne.

Proč k tomu dochází

Konvence se zapisují jako poslední, protože pro lidi, kteří je mají, nejsou znalostí, jsou prostě tím, jak věci jsou. Zapíše se README o produktu. Rozdíl mezi obojím je přesně ta mezera, do které nováček spadne.

Proč to lepší model nevyřeší

Neznámý repozitář je problém informací, ne uvažování. Silnější worker odvodí konvence rychleji a odvodí tytéž špatné, protože důkaz v kódu je skutečně nejednoznačný — právě proto musela být konvence konvencí.

Co to stojí

Hodina až den na každý příchod, násobeno tím, jak často příchody nastávají — což je s jednorázovými relacemi dnes několikrát denně, ne několikrát ročně. A odvození, která byla chybná, se platí podruhé, při review.

Co Majordomus dělá

Vrstva je jeden adresář s manifestem, který jmenuje každou sekci a který přečte člověk bez nainstalovaného nástroje. Její protokol je uveden jednou: přečti manifest, načti sekce, které úloha potřebuje, rozřeš pravidla a jejich závislosti, nikdy nenačítej lokální polovinu. Každý adresář nese kontextový dokument, který se přidává k předkům, takže to, co cestu řídí, se pro ni skládá, místo aby se hledalo. Převzetí existujícího repozitáře je podporovaný výchozí bod: stávající instrukční soubory jsou vstupem první politiky, ne něčím, co se nahrazuje.

Před a po

before   "read the README, then ask me"

after    $ majordomus context resolve lib/payments
         .ai/README.md            the protocol of the layer
         .ai/repo/README.md       what is canonical here
         lib/payments/README.md   amounts are integers in minor units, and why

Co nedělá

Nepíše konvence za vás a prázdná vrstva nevysvětluje nic. Činí zřejmým místo, kam patří, a jejich nalezení deterministickým.

Jak to vypadá

Konkrétní situace, jedna pro každé publikum. Každá je deklarována v záhlaví okamžiku, takže stav před a po jsou data, ne próza, od které by se stránka mohla odchýlit.

  1. Nový účet, nová kódová základna agency

    před
    První den konzultanta se tráví odvozováním konvencí z kódu a odvození se mýlí právě v tom, na čem záleží.
    po
    Vrstva je jeden adresář s manifestem; `context resolve` složí řetězec pro libovolnou cestu, jíž se chystají dotknout.
  2. Příležitostný příspěvek open-source-maintainer

    před
    Přispěvatel napíše rozumný patch v nejméně oblíbeném stylu projektu a maintainer mu to při revizi vysvětluje.
    po
    Konvence jsou rozsahové dokumenty v repozitáři, dohledatelné z měněné cesty.
  3. Worker bez lokálních znalostí ai-native-team

    před
    Relace je namířena na repozitář a má být užitečná; čte cokoli, co jí náhodou přijde pod ruku.
    po
    Má pokyn přečíst protokol vrstvy a vyřešit kontext pro danou cestu a řešení je deterministické.

Jak to poznáte

Pozorovatelné příznaky, které tento okamžik deklaruje. Jsou dotazníkem na indexu a vstupem pro majordomus why diagnose; nic jiného je nedefinuje.

  • Zproduktivnění v tomto repozitáři vyžaduje zeptat se někoho, kdo ho už zná. ask-a-regular
  • Co je tu konvencí, není zapsáno nikde, kde by to nováček našel. conventions-undocumented
  • Každý nový člověk nebo worker opakuje totéž objevování. every-arrival-pays

Kde to v nástroji najdete

Vše níže je načteno z vlastního záhlaví tohoto okamžiku a ověřeno proti repozitáři. Neexistující název by neprošel validací.

příkazy, které na to odpovídají

schopnosti spustitelného souboru, které na to odpovídají

co dohlíží — odvozeno z tvrzení níže

tvrzení, která tuto stránku podpírají, a důkazy za každým z nich

pravidla, která jej řídí

  • majordomus.context-integrity
  • majordomus.ai-layout-integrity
  • project.context-locality
  • majordomus.minimum-sufficient-context

případy užití, které ukazují cestu ven

Pokud vám tohle zní povědomě, další také

Co tento okamžik pojmenovává, co pojmenovává jeho a co sdílí jeho oblast, publikum nebo štítky. Druhé a třetí je odvozeno; zapsáno je jen první.

Všech 38 a jak souvisejí s nástrojem →

Prohledává názvy a popisy všech stránek, které tento web publikuje.