Gennemgang af pull-anmodninger¶
Vi er altid glade for at modtage anmeldelser fra bidragydere, uanset deres erfaringsniveau.
Hvorfor gennemgå bidrag?¶
Hvert bidrag, der indsendes, skal gennemgås, uanset om det er indsendt af et kernemedlem eller en førstegangsbidragyder. Alle kan komme til at overse noget. Gennemgangsprocessen er indført for at give et ekstra sikkerhedsnet.
Formålet med gennemgangsprocessen er at sikre, at alt indhold, herunder kode og dokumentation, er så fejlfrit og let at vedligeholde som muligt. Alt, hvad du kan gøre for at fremme dette mål, er et velkomment bidrag. Det kan være alt fra noget så simpelt som at rette en stavefejl til at finde kanttilfælde i API-brugen, der ikke bliver opdaget. Du kan identificere måder, hvorpå testproceduren kan gøres mere robust, eller komme med forslag til, hvordan den overordnede arkitektur for ændringerne kan struktureres, så de bliver nemmere at vedligeholde eller udvide.
Kan jeg gennemgå det?¶
Ja! Du kan give en anmeldelse på alle pull-anmodninger, du ser åbne på BeeWare.
Som førstegangsbidragyder skal du føle dig fri til at gennemgå alle pull-anmodninger, du finder, selvom de er indsendt af et medlem af kerneteamet. Hvis du er nybegynder, mangler du måske noget af den større projektkontekst, men vi tilstræber at holde kodebasen tilgængelig uanset dit erfaringsniveau. Hvis der er noget i koden, der ikke giver mening, kan det være et tegn på, at der er behov for mere dokumentation (enten i koden eller som selvstændig designdokumentation).
Bidrag med en pull request-gennemgang¶
Gennemgang af pull-anmodninger
Alle er velkomne til at gennemgå ethvert bidrag til BeeWare-projektet. Der er nogle vigtige overvejelser, man skal være opmærksom på, inden man går i gang.
TÆNK, før du anmelder¶
Tænk dig godt om, før du går i gang med en anmeldelse. Som anmeldere bør vi overveje, om det svar, vi er ved at sende, er:
- Det er rigtigt. Stræb altid efter at give præcise forslag og oplysninger.
- Nyttigt. Vi giver vejledning i, hvordan indsendelsen kan forbedres. Denne vejledning skal klart identificere kilden til et problem eller en uovervejet brugssituation og ideelt set give en vej frem til, hvad der kan løse eller imødekomme problemet.
- Inspirerende. Det er op til os at inspirere forfatteren til at gennemføre de ændringer, vi har bedt om.
- Nødvendigt. Forfatteren forventes at læse alt, hvad vi poster; vi skal respektere deres tid og indsats ved kun at poste, når det er nødvendigt.
- Venlig. Der er flere måder at give den samme feedback på; vi skal sikre os, at vi vælger at være venlige, støttende og konstruktive i vores ordvalg.
Det er fuldt ud muligt at TÆNKE, samtidig med at man giver en effektiv anmeldelse. De ovenfor nævnte koncepter udelukker ikke, at man påpeger eventuelle problemer, man finder i en PR. Bidragsydere har ikke mulighed for at forbedre deres bidrag, hvis de ikke er opmærksomme på de områder, der skal forbedres. Det vigtige er at være opmærksom på, hvordan man præsenterer denne feedback. Prøv at gøre din gennemgang upersonlig. I stedet for at sige "Du har lavet en fejl" kan du sige "Denne kode kunne forbedres". Gennemgå koden, ikke forfatteren.
Det er vigtigt at huske at give positiv feedback ud over at identificere de områder, der skal forbedres. Hvis ændringerne for eksempel er særligt nyttige, gør noget særligt smart, eller du bliver introduceret til et API, som du ikke kendte til, så lad forfatteren vide det! Undervurder aldrig effekten af at påpege noget, som nogen har gjort korrekt eller godt, midt i en situation, hvor alt andet, du har påpeget, er problemer, der skal løses.
Forslag til GitHub-gennemgang¶
GitHub-gennemgangsgrænsefladen har en mekanisme til ændringsforslag, hvor du kan angive den nøjagtige ændring, du foreslår, som erstatning for det eksisterende indhold. Husk, at disse foreslåede ændringer ikke gennemgår pre-commit og linting-kontrol, før de er accepteret og committet. Derfor bør denne funktion kun bruges til mindre ændringer, da jo større den foreslåede ændring er, jo større er sandsynligheden for, at den medfører problemer.