Læringssti 07Lektion 2 / 8

Importér en eksisterende kodebase i Taiga

Gennemgå det, Taiga udleder af et repository. Skeln mellem nuværende og tilsigtet adfærd, og vælg den rette handling for et unøjagtigt dokument.

Praktisk11 minReviewet

Udgivet af Sådan skriver vi

Det lærer du

  • Forbered et tilknyttet repository til et importeret produkt.
  • Skeln mellem en kodefejl, en stående instruktion og en analysefejl.
  • Gennemgå foreslåede initiativer mod faktiske mangler og eksisterende funktioner.

Start med det system, du har

En fiktiv tjeneste til udstyrsbestillinger findes allerede. Teamet vil vedligeholde den med Taiga og bevare dens fungerende integrationer.

Vælg Import codebase, når produktet oprettes. Tilknyt repositoryet, og start analysen. Forløbet bruger repositoryanalyse i stedet for samtalen for et nyt produkt. Et produkt oprettet fra bunden får ikke denne importmulighed senere.

Bekræft repositoryadgang og den branch, Taiga skal arbejde mod. Tilføj stående begrænsninger på det rette kontekstniveau. Angiv i eksemplet, at den eksisterende integration til medarbejderidentitet skal forblive i brug.

Gennemgå først den udledte specifikation

Taiga udleder produktdokumenter af koden og medtager repositoryreferencer. Referencerne hjælper med at kontrollere fortolkningen. De fastslår ikke forretningshensigten bag hvert eksisterende mønster.

Undersøg tre ting i specifikationen:

  • Formål: Matcher det beskrevne mål årsagen til, at tjenesten findes?
  • Begrænsninger: Hvilke mønstre er bevidste krav?
  • Kendte fejl: Hvilken nuværende adfærd bør ændres?

Udstyrstjenesten indeholder et ældre autorisationsmodul. Et dokument kan korrekt beskrive brugen af det. Det betyder ikke, at teamet bør udvide modulet.

Åbn en refereret fil, og sammenlign den relevante adfærd med påstanden. Registrér begrænsninger i den tilgængelige dokumentation, eksempelvis konfiguration eller driftsadfærd uden for repositoryet.

Vælg den rette rettelse

SituationHandling
Dokumentet beskriver korrekt uønsket kodePlanlæg og implementér kodeændringen
Teamet har en stående regel for fremtidigt arbejdePlacér reglen i produktinstruktioner
Analysen fejlfortolkede repositoryetBrug Refresh this document, og undersøg resultatet

Importerede dokumenter følger koden. Behandl dem ikke som manuelt vedligeholdte beskrivelser af et fremtidigt system. En dokumentopdatering udleder også de dokumenter igen, som dokumentet afhænger af. Opdatering af et senere dokument kan derfor kræve mere arbejde.

For det ældre modul kunne en instruktion være: »Tilføj ikke nye kaldere til det ældre autorisationsmodul. Brug det godkendte erstatningsinterface til nyt arbejde.« Verificér, at interfacet findes, og angiv dets faktiske placering i repositoryet.

Vurdér de første initiativer

Importforløbet kører også repositoryscanninger, vurdering mod publicerede politikker og indledende initiativplanlægning. Et trin uden sin forudsætning kan springes over med en forklaring. Planlægningen bruger de fund og den politikvurdering, der er tilgængelige.

Gennemgå de foreslåede mangler mod repositoryet. De første initiativer håndterer manglende funktioner, fundamenter eller relevante uløste afhængighedsproblemer. De er ikke en liste over nye funktioner, som ingen har bedt om.

Bevar en nyttig eksisterende funktion. Afvis eller ret et forslag, der ville genopbygge den unødvendigt. Tilføj et særskilt initiativ for et nyt forretningskrav.

Bevar et dokumenteret udgangspunkt

Afslut Discovery, og gennemgå initiativforslagene. Bekræft miljø og leveranceansvar før detaljeret planlægning. Hold import, kodeændringer og produktinstruktioner konsistente, mens arbejdet fortsætter.

Resultatet er et forstået udgangspunkt og en redigerbar backlog. Det er ikke en erklæring om, at al eksisterende adfærd er korrekt. Fortsæt med initiativplanlægning.

Lav øvelsen

En importeret fiktiv tjeneste bruger et ældre autorisationsmodul. Udskiftningen er allerede planlagt. Skriv en produktinstruktion, der forhindrer nye afhængigheder af modulet. Identificér derefter én repositoryreference, du ville undersøge i den importerede specifikation.

Download arbejdsark (Markdown)

Kontrollér din forståelse

Et importeret dokument beskriver korrekt kode, som du vil erstatte. Hvad er den rette handling?

Kilder og videre læsning

Relateret læsning fra Taiga