Pull-förfrågningar

På den här sidan beskrivs de verktyg som används för att bidra till och granska kod.

Granskningar är en viktig åtgärd för att säkerställa att ändringar är av god kvalitet. De hjälper till att förebygga buggar, designkonsistenser eller potentiella underhållsproblem. Och att få sitt arbete granskat håller dig också på tårna.

Observera

Skribenter som har fått tillgång till commit kan göra commit till huvudarkivet utan att behöva förgrena arkivet.

Se Riktlinjer för åtaganden om detta gäller dig.

Engångsinställning

Detta förutsätter att du redan har Blender Manual Repository utcheckat på din dator och följer installationsanvisningarna.

Förgrena

  1. Gå till Blender repository och klicka på Fork-knappen.

  2. Bekräfta gaffeln med standardinställningarna.

  3. Nu måste du lägga till din personliga fork som en fjärrkontroll i ditt lokala git-repository. Klicka på SSH för att se rätt URL, och lägg sedan till den så här:

    git remote add me git@projects.blender.org:<USERNAME>/blender-manual.git

Observera

För att kunna skicka till gaffelförrådet behöver du en SSH-nyckel. Om du inte redan har filen ~/.ssh/id_rsa.pub finns det ett enkelt kommando för att generera sådana nycklar som fungerar på Linux, macOS och i Git Bash på Windows:

ssh-keygen

Det här kommandot genererar en privat nyckel id_rsa och en offentlig nyckel id_rsa.pub i ~/.ssh. Den privata nyckeln får aldrig visas eller skickas till någon annan för att undvika att ditt konto äventyras, men den offentliga nyckeln är säker att dela.

Innehållet i ~/.ssh/id_rsa.pub kan kopieras och klistras in i kontoinställningar på projects.blender.org, efter att du klickat på ”Add Key”. Vilket namn som helst för SSH-nyckeln är ok.

Arbetsflöde

Arbetsflödet för att arbeta med pull requests finns i Blender Developer’s Documentation.

Observera att en del text i ovanstående riktlinjer är inriktad på Blenders huvudarkiv, men arbetsflödet är detsamma för alla Blender-projekt.

Riktlinjer för granskare

  • Texten i pull request ska kunna användas som git commit-meddelande (se riktlinjer för mer information).

  • Var tydlig med när vissa ändringar ska åtgärdas innan du går vidare, utan att behöva göra en ny granskning.

  • Om pull request inte godkänns förväntas författaren göra en ny iteration.

  • Om ändringen kräver enighet om designuppgiften först, lägg pull request i vänteläge genom att lägga till prefixet ”WIP” i titeln, vilket indikerar att författaren anser att pull request inte är redo att slås samman. Ingen granskning förväntas om inte författaren specifikt ber om det.

  • Skribenter förväntas svara på pull requests inom 3 arbetsdagar.

  • Lägg till relevanta moduler/projekt på etiketterna.

  • Uppmuntra nya skribenter att göra granskningar, det är ett bra sätt att lära sig och viktigt för att utveckla projektet.

Tips

  • För att hämta patch-filen lägger du till .patch i slutet av URL:en för pull request. Exempel:

    https://projects.blender.org/blender/blender-manual/pulls/104892.patch

  • Checka ut en pull request till ett fristående huvud (utan att lämna kvar en gren). Exempel:

    git fetch -q origin +refs/pull/104892/head: ; git checkout -qf FETCH_HEAD