Dokumentation

Kör din första uppgift

Beskriv ett arbete, godkänn planen och se Coroid bygga och verifiera det.

En uppgift är en arbetsenhet som avslutas med en pull request. Starta en från Nytt arbete, och välj Uppgift under Skapa som. Om du låter den stå på Automatisk låter du Coroid välja mellan en uppgift och en plan.

Välj en bra första uppgift

Den bästa första uppgiften är liten, verklig och nära befintliga tester. Något i stil med ”lägg till en --json flagga till exportkommandot, med samma utdataformat som importkommandot redan godtar” ger Coroid ett tydligt mål och dig en tydlig bild av resultatet.

Undvik följande i första körningen:

  • allt som rör autentisering, betalningar eller datamigrering
  • arbete som kräver ett designbeslut du inte har fattat än
  • vaga upprensningar – ”förbättra felhanteringen” har inget tydligt slut

Beskriv vad du vill ha

Beskriv resultatet, inte hur det ska implementeras. Säg vad som ska gälla när arbetet är klart, och nämn sådant som inte är självklart: viktiga filer, konventioner att följa, saker som inte ska ändras.

Du behöver inte skriva planen. Det är det första Coroid tar fram, och du får godkänna den.

Om det finns sammanhang som inte framgår av koden – ett ADR, en stilguide, ett ärende – bifoga det. Se Projektkontext för att se vad Coroid redan känner till.

Nytt arbete
Beskriv resultatet. Coroid hittar rätt sätt att leverera det.
Skapa som
AutomatisktUppgiftPlan
Coroid väljer resultatet, eller så kan du välja det själv.
Projekt
web-app
Titel på arbetet
Låt kunder exportera sina fakturor som CSV
Beskrivning

Ekonomiteam frågar hela tiden efter sina fakturor i ett kalkylark. Lägg till en exportknapp i fakturalistan som laddar ner det aktuella filtret som CSV.

Klart när: filen öppnas i Excel och Numbers, beloppen anges i kontots valuta och exporter med fler än 10 000 rader inte överskrider tidsgränsen.

Bifoga filer
Nästa: kvalificering. Inget har skapats ännu.Fortsätt

Formuläret för nytt arbete: välj vad du vill skapa, välj projekt och beskriv sedan resultatet med en titel och en kort beskrivning.

Fortsätt genom kvalificeringen

Välj Fortsätt. Inget skapas ännu: Coroid granskar förfrågan, kontrollerar den mot den aktuella releasen, letar efter dubbletter och bekräftar arbetsflödet. När den godkänns skapas uppgiften och läggs i kön. Om kvalificeringen stoppar den visar kontrollerna varför. Du kan då redigera förfrågan och försöka igen. Se Beskriv vad du behöver.

Granska specifikationen

Coroid omvandlar din beskrivning till en specifikation: vad som ska byggas, vad som inte ingår och vilka acceptanskriterier som avgör om resultatet är godkänt. Den visas på fliken Specifikationer för uppgiften.

Läs den innan något byggs. Om acceptanskriterierna inte stämmer med vad du faktiskt vill ha bör du ändra dem nu – det är mot dem verifieringen senare testar. Se Specifikationer.

Godkänn planen

För allt utom en helt trivial ändring blir specifikationen en plan: en ordnad uppsättning steg. Du godkänner den innan koden skrivs.

Det här är det enklaste tillfället att ingripa. Det kostar dig en minut att avvisa en plan. Att avvisa en färdig pull request kostar en hel körning.

Följ arbetet

När uppgiften har skapats hamnar den i PENDING tills en agentplats blir ledig, och sedan IN_PROGRESS. Du kan följa körningen i realtid: stegen som tas, verktygen som används, filerna som ändras och testresultaten allt eftersom de kommer in.

Du behöver inte följa arbetet. Aviseringar talar om när det behöver dig eller när det är klart.

Vad du kan förvänta dig

  • Tidsåtgång beror på ändringens omfattning och hur lång tid testsviten tar, inte på hur många agentplatser du har. Platserna avgör hur många uppgifter som körs samtidigt.
  • NEEDS_HUMAN_REVIEW är inget misslyckande. Det betyder att Coroid stötte på ett beslut som bara du kan fatta. Svara på frågan så fortsätter uppgiften.
  • Omarbete är normalt. Om granskaren hittar något går uppgiften tillbaka till utvecklaren innan du får se den.

Nästa

Granska och merga resultatet – vad som levereras och vad du ska kontrollera.