GitHub (och Git) är ett kraftfullt system med många finesser och funktioner, och kan lätt bli komplicerat. Målet är att få en bra balans mellan användbarhet och säkerhet, men det kommer ändå vara en tröskel att ta sig över.
Grundidén är att man gör alla sina ändringar på en kopia av stadgarna, och sedan måste ändringarna granskas och godkännas innan de förs in i det skarpa dokumentet. Vi behöver även hålla koll på vad som behöver göras, och vem som arbetar på vad, och vi använder GitHubs interna issue-system för att hålla koll på det, samt för diskutera de enskilda uppgifterna.
Arbetsflödet kan förenklas till följande:
- Skapa ett issue som beskriver det du vill diskutera eller arbeta på
- Vi diskuterar issuet tills vi kommit överens om vad som ska göras
- Börja arbeta med issuet på en separat kopia av stadgarna (en så kallad "branch")
- Lägg upp ditt arbete för granskning när det är klart
- Lägg till ditt arbete i stadgarna efter godkänd granskning
För att underlätta de tekniska delarna så har jag (Häggmyr) försökt göra en så användarvänlig guide som möjligt, med bilder för varje steg i processen.
Dokumentet ser nog mastigare ut än det egentligen är, och efter att man gjort sakerna en gång eller två borde man ha ganska bra koll på hur man bör göra. Om det är något som är oklart eller saknas så hör av er till mig, jag använder GitHub dagligen så det är väldigt lätt att bli hemmablind.
Genom att klicka på Issues kommer man till en lista med de saker som behöver diskuteras och/eller fixas.
De som är markerade med taggen "diskussion" är tänkta att diskuteras, antingen på ett möte eller direkt i kommentarerna på issuet. När konsensus har uppnåtts om vad som behövs göras kan taggen tas bort, och issuet antingen börja arbetas på eller stängas beroende på vad diskussionen landade i.
Genom att gå till "Projects" och klicka på "Stadgerevidering" (direktlänk här) kan man se vilken status olika issues har.
De som ligger i "To do"-kolumnen och inte har en "diskussion"-flagga är redo att börja arbetas på. Ta tag i issuet du vill arbeta med och dra över det till "In progress"-kolumnen, så vi vet att någon arbetar på det. Du kan gärna markera dig själv som assigned på issuet också, och sedan kan du börja arbeta (se guiden för hur man gör dessa två saker).
När du arbetat färdigt ska du göra en "pull request" för att få in dina ändringar, se guiden för hur man gör det.
Genom att klicka på Pull requests kommer du till en lista med de ändringar folk anser sig vara klara med och vill ha in i stadgarna.
Varje pull request behöver granskas och godkännas av två personer för att få föras in, så om du ser någon som behöver fler granskare är du fri att ta en närmare titt på den (se guiden för en mer detaljerad guide i hur granskningen går till).
Det går att kommentera på pull requesten även om man inte är granskare, så man behöver inte känna sig låst till att bara kommentera på de som man granskar.
Om du själv har lagt upp en pull request som sedan blivit godkänd är du fri att föra in den. Exakt hur du gör det står i guiden.