Modtagelse af en pull request-gennemgang¶

Din pull-anmodning er blevet indsendt og har bestået CI. Den er nu klar til gennemgang.

tl;dr - Gennemgangsprocessen¶

Den korte version af gennemgangsprocessen:

Vent på en anmeldelse.
Reager på feedback.
Hvis der anmodes om ændringer:
Arbejd med at gennemføre de ønskede ændringer.
Indsend alle ønskede ændringer.
Anmod om en ny gennemgang, når alle ønskede ændringer er blevet indsendt.
Gentag afsnit tre, indtil der ikke er behov for yderligere ændringer.
Vent på, at din pull-anmodning bliver godkendt og flettet.

Tillykke! Du har netop bidraget til BeeWare!

Jeg har indsendt min pull-anmodning, hvad sker der nu?¶

Når du har indsendt din pull-anmodning, skal du vente på, at dit bidrag bliver gennemgået. Der er to sider af gennemgangsprocessen: at give en gennemgang og at modtage en gennemgang.

Gennemgå forventninger

Du bør forvente, at alle, der gennemgår dine indsendelser, følger disse retningslinjer, herunder gennemgange fra medlemmer af kerneteamet. Du bør også følge disse retningslinjer, når du gennemgår indsendelser fra andre.

Hvis du føler, at din korrekturlæser afviger fra disse forventninger, og du føler dig komfortabel med selv at rejse spørgsmålet i pull-anmodningen, kan du gøre det. Hvis du ikke føler dig komfortabel med det, bedes du kontakte BeeWare Code of Conduct Response Team. Vi vil gennemgå din rapport og følge op med din korrekturlæser. Opfølgningen vil afspejle den rapporterede handling; en mindre overtrædelse kan resultere i en diskussion, mens en større overtrædelse kan resultere i noget mere alvorligt.

Giver en anmeldelse¶

Alle er velkomne til at give en anmeldelse på enhver pull-anmodning. Disse retningslinjer beskriver vores forventninger til en anmeldelse, uanset om den kommer fra et kerneteammedlem eller et medlem af fællesskabet.

Et kerneteammedlem skal altid foretage den endelige gennemgang, men gennemgange fra medlemmer af fællesskabet kan være en nyttig måde at strømline processen på. Ideelt set vil gennemgangen fra kerneteamet være en formalitet, efter at fællesskabets gennemgange har identificeret alle de væsentligste problemer.

Modtagelse af en anmeldelse¶

Modtagelse af en anmeldelse involverer tre grundlæggende trin:

Indledende feedback og spørgsmål.
Ændringsanmodninger.
Godkendelse og sammenlægning.

Hvert trin er beskrevet nedenfor. Hvis du på noget tidspunkt under processen har spørgsmål, så tøv ikke med at spørge! Vi hjælper gerne.

Tidsplan og indledende feedback¶

Kerneteamet tilstræber at sikre, at alle pull-anmodninger bliver gennemgået inden for ti arbejdsdage. Ved mere komplicerede indsendelser eller når en pull-anmodning indsendes, mens dele af teamet er på ferie, kan denne tidsramme dog blive forlænget.

Vi opretholder typisk kontinuitet med korrekturlæsere på hver pull-anmodning – det vil sige, at du sandsynligvis vil arbejde med den samme korrekturlæser under hele korrekturlæsningen. Det betyder, at din korrekturlæser har overblik over hele processen, og at du kan lære, hvad du kan forvente med hensyn til svarfrekvens og korrekturlæsningsstil. Hvis din oprindelige korrekturlæser vurderer, at han eller hun ikke har den nødvendige ekspertise til at gennemgå dine pull-anmodninger, eller ved, at han eller hun af en eller anden grund ikke vil være tilgængelig, kan han eller hun overdrage ansvaret for din pull-anmodning til et andet teammedlem.

Du kan forvente, at vi svarer på hver henvendelse inden for en periode på ti arbejdsdage. At svare på feedback og spørgsmål er en vigtig del af gennemgangsprocessen. Vi forventer et svar fra dig, før vi går videre til næste trin i processen.

Ændringsanmodninger¶

I de fleste tilfælde vil din korrekturlæser anmode om ændringer i din pull-anmodning. Dette er ikke nødvendigvis et udtryk for kvaliteten af dit arbejde, men blot en del af processen.

Hvis den indledende gennemgang afslører et betydeligt antal problemer, er den første gennemgang muligvis ikke udtømmende. I stedet vil den fokusere på at give overordnede retningslinjer for det arbejde, der er nødvendigt for at bringe pull-anmodningen i en tilstand, hvor den kan flettes. Gennemgangsprocessen kan omfatte spørgsmål for at afklare formålet med og omfanget af det arbejde, der er forsøgt udført.

Arbejd med de ønskede ændringer¶

Din korrekturlæser vil skrive kommentarer til din pull-anmodning. Disse kommentarer kan være generelle, vedrøre en bestemt fil eller en eller flere bestemte kodelinjer. De vil undertiden indeholde direkte forslag til ændringer, som du kan anvende på din pull-anmodning via GitHub-brugergrænsefladen. Typisk vil det være spørgsmål, anmodninger om afklaring eller vejledning om opdateringer.

Markering af en samtale som løst

Under diskussionsdelen af feedbackprocessen bør du aldrig markere en samtale, der er startet af din korrekturlæser, som "løst". Det er korrekturlæserens ansvar at markere samtalen som løst. Det er op til dem at afgøre, om det identificerede problem er blevet løst.

Hvis gennemgangen afslører et systematisk problem (f.eks. en inkonsekvens i navngivningen i koden), behøver korrekturlæseren ikke fremhæve alle forekomster af dette problem. I stedet kan vedkommende vælge et par eksempler på problemet og angive, at andre forekomster også bør rettes. Hvis en gennemgang fremhæver et problem ét sted, og du mener, at det også kan være tilfældet andre steder, bør du rette problemet, uanset hvor det forekommer. Hvis du er i tvivl, kan du bede korrekturlæseren om en afklaring.

Indsend alle ønskede ændringer¶

Når du har gennemgået alle de ønskede ændringer, kan du sende en opdatering til din pull-anmodning. Dette vil udløse en ny CI-kørsel. Når du har bekræftet, at CI stadig er godkendt, skal du skrive en kommentar, hvor du anmoder om en opdateret gennemgang, og kerneteamet vil se på din pull-anmodning igen.

Skub, ikke tving eller rebase

Når du opdaterer din pull-anmodning under en gennemgang, er det vigtigt at lade commit-historikken være intakt. Det betyder ikke noget, om der er en lang liste med commits; de bliver alle sammen slået sammen, når vi fletter pull-anmodningen. Hvis du tvinger push eller rebase din pull-anmodning midt i en gennemgang, risikerer du at fjerne vigtig kontekst, som din gennemgangskonsulent har brug for.

Anmod om en ny gennemgang¶

Når du har løst alle de ønskede ændringer i en given gennemgang, og CI igen er godkendt, kan du anmode om en ny gennemgang fra din korrekturlæser. Hvis et problem er særligt kompliceret, og løsningen af det ene problem vil påvirke et andet, kan du anmode om en gennemgang af det specifikke element, du har opdateret. Det antages, at enhver anmodning om en gennemgang er en anmodning om en fuldstændig gennemgang. Hvis du ikke er klar til en fuldstændig gennemgang, skal du sørge for at specificere præcis, hvad du ønsker.

Godkendelse og sammenlægning af pull-anmodninger¶

Når du har besvaret alle ændringsanmodninger, vil pull-anmodningen blive godkendt. I de fleste tilfælde vil vi straks sammenflette pull-anmodningen, når den er godkendt. I nogle tilfælde kan der være formildende omstændigheder, f.eks. hvis den er afhængig af en anden pull-anmodning, der endnu ikke er sammenflettet, hvilket vil medføre en forsinkelse. Vi vil kommunikere dette i kommentarerne, så du er klar over situationen.