Ta in en befintlig kodbas i Taiga
Granska vad Taiga härleder från ett repository. Skilj aktuellt beteende från avsett beteende och välj rätt åtgärd för ett felaktigt dokument.
Publicerad av TaigaSå skriver vi
Det här lär du dig
- Förbered ett länkat repository för en importerad produkt.
- Skilj ett kodfel, en stående instruktion och ett analysfel åt.
- Granska föreslagna initiativ mot faktiska luckor och befintliga förmågor.
Börja med systemet du har
En fiktiv tjänst för utrustningsförfrågningar finns redan. Teamet vill underhålla den med Taiga och samtidigt bevara fungerande integrationer.
Välj Import codebase när produkten skapas. Länka repositoryt och starta analysen. Denna väg använder repositoryanalys i stället för samtalet för en ny produkt. En produkt som skapats från grunden får inte denna importväg senare.
Bekräfta repositoryåtkomsten och den branch Taiga ska arbeta mot. Lägg till stående begränsningar på rätt kontextnivå. Ange i exemplet att den befintliga integrationen för anställdas identitet måste fortsätta användas.
Granska den härledda specifikationen först
Taiga härleder produktdokument från koden och inkluderar repositoryhänvisningar. Hänvisningarna hjälper dig att kontrollera tolkningen. De fastställer inte verksamhetsavsikten bakom varje befintligt mönster.
Granska tre saker i specifikationen:
- Syfte: Stämmer det beskrivna målet med varför tjänsten finns?
- Begränsningar: Vilka mönster är avsiktliga krav?
- Kända fel: Vilka nuvarande beteenden ska ändras?
Utrustningstjänsten innehåller en äldre auktoriseringsmodul. Ett dokument kan korrekt beskriva dess användning. Det betyder inte att teamet ska bygga vidare på den.
Öppna en citerad fil och jämför det relevanta beteendet med påståendet. Dokumentera begränsningar i det tillgängliga underlaget, till exempel konfiguration eller driftbeteende utanför repositoryt.
Välj rätt korrigering
| Situation | Åtgärd |
|---|---|
| Dokumentet beskriver oönskad kod korrekt | Planera och bygg kodändringen |
| Teamet har en stående regel för framtida arbete | Lägg regeln i produktinstruktionerna |
| Analysen feltolkade repositoryt | Använd Refresh this document och granska resultatet |
Importerade dokument följer koden. Behandla dem inte som manuellt underhållna beskrivningar av ett framtida system. En dokumentuppdatering härleder också dokumenten som det beror på på nytt. Att uppdatera ett senare dokument kan därför kräva mer arbete.
För den äldre modulen kan en instruktion säga: ”Lägg inte till nya anropare till den äldre auktoriseringsmodulen. Använd det godkända ersättningsgränssnittet för nytt arbete.” Verifiera att gränssnittet finns och ange dess faktiska plats i repositoryt.
Bedöm de första initiativen
Importflödet kör också repositoryskanningar, bedömning mot publicerade policyer och inledande initiativplanering. Ett steg som saknar sin förutsättning kan hoppas över med en förklaring. Planeringen använder de fynd och den policybedömning som finns tillgängliga.
Granska de föreslagna luckorna mot repositoryt. De första initiativen hanterar saknade förmågor, grundläggande delar eller relevanta olösta problem med beroenden. De är inte en lista med nya funktioner som ingen har bett om.
Behåll en användbar befintlig förmåga. Avvisa eller korrigera ett förslag som skulle bygga om den i onödan. Lägg till ett separat initiativ för ett nytt verksamhetskrav.
Bevara en startpunkt grundad i underlag
Avsluta Discovery och granska initiativförslagen. Bekräfta miljön och leveransansvaret före detaljerad planering. Håll import, kodändringar och produktinstruktioner konsekventa under arbetets gång.
Resultatet är en förstådd startpunkt och en redigerbar backlog. Det är inte en förklaring om att allt befintligt beteende är korrekt. Fortsätt med initiativplanering.
Gör övningen
En importerad fiktiv tjänst använder en äldre auktoriseringsmodul. En ersättare är redan planerad. Skriv en produktinstruktion som förhindrar nya beroenden till modulen. Identifiera sedan en repositoryhänvisning som du skulle granska i den importerade specifikationen.
Ladda ned övningsblad (Markdown)Kontrollera din förståelse
Källor och vidare läsning
Relaterad läsning från Taiga
Om du avmarkerar valet raderas alla framsteg som sparats i den här webbläsaren.
Framstegen stannar i webbläsaren. Inget konto, ingen spårning.