CONTRIBUTING

Vill du hjälpa till att göra den här dokumentationen bättre? Gör det via dess githubsida!

Issues

Om du själv inte vill gå in och ändra, kan du använda GitHubs system för "issues". En issue kan vara nästan vad som helst – oftast en buggrapport, eller ett förbättringsförslag.

Kolla först ifall det du vill rapportera/föreslå inte redan finns som en issue; använd sökfunktionen på sidan om det finns många öppna issues.

Om inte – skapa en ny Issue, ge den en titel och en beskrivning. Ju tydligare desto bättre och desto större sannolikhet att den fixas inom rimlig tid!

Skicka in din issue och vänta på att någon ska svara på den och/eller fixa den. När issuen 'r färdigbehandlas blir den "stängd".

Forks och pull requests

Om du vill vara med och göra ändringar mer direkt, gör en fork av projektet! För dig som är ny betyder det alltså:

• Gör en fork genom att klicka på "fork"-knappen på projektets startsida på Github.

• Gör de ändringar du vill se i din fork. All dokumentation är skriven i GitBooks variant av språket Markdown.

  • Ett sätt att göra detta är att klona ner din kopia av projektet till din dator, och sedan gör ändringar i t.ex. Visual Studio Code. Du gör då commits som vanligt och sedan pushar du dem till Github.

  • Ett annat sätt är att redigera direkt på github – gå till din fork på Github och tryck punkt (.) för att öppna en webbversion av Visual Studio Code. Gör dina ändringar, spara, gör en commit.

• Sedan gör du en pull request där du beskriver det du ändrat.

• Om dina ändringar ser bra ut så kommer din pull request att godkännas och projektet uppdateras.

Göra egna forks utan pull request

Du kan och får naturligtvis göra helt egna forks där du gör vilka ändringar du vill – det finns inga som helst krav på att du bidrar till det här projektet. Du får också hemskt gärna använda den här dokumentationen som grund för något eget, om du t.ex. vill göra en dokumentation till något annat programmeringsspråk.