Kom i gang med GitHub

GitHub er en platform, hvor man kan samle filer, dokumentation og opgaver og samarbejde om ændringer. Platformen bruges især til softwareudvikling, men du behøver ikke kunne programmere for at bruge den.

Her får du en introduktion til GitHub og hjælp til at finde eller oprette et repository til dit OS2-produkt eller -projekt.

Mange OS2-produkter og -projekter bruger GitHub, men andre Git-baserede platforme kan også anvendes.

Indholdsfortegnelse

  1. Hvad kan GitHub bruges til?
  2. Hvad er et repository?
  3. Find eller opret et repository
  4. Husk README-filen

Hvad kan GitHub bruges til?

I et OS2-produkt eller -projekt kan GitHub blandt andet bruges til at:

  • Finde og dele kildekode, dokumentation og vejledninger.
  • Følge opgaver, fejl og udviklingsønsker.
  • Samarbejde om dokumenter og holde styr på ændringer.
  • Udgive dokumentation på et docsite.

Hvad er et repository?

På GitHub organiseres arbejdet i repositories (ofte kaldet repoer).

Et repository kan sammenlignes med en projektmappe, hvor man samler filer og samtidig kan følge ændringer og tidligere versioner. Et repository kan være offentligt eller have begrænset adgang.

Se et eksempel: OS2-håndbogens repository på GitHub. Her ligger filerne, som håndbogen er bygget af, og du kan se, hvordan ændringer til dokumentationen håndteres.

Find eller opret et repository

  • Har produktet eller projektet allerede et repository? Tag udgangspunkt i det eksisterende.
  • Skal der oprettes et nyt? Afklar placering og ansvar med de relevante personer.
  • Brug eksisterende skabeloner: OS2 har skabeloner, som kan hjælpe med at opbygge et repository.

Vejledning under udarbejdelse

De konkrete arbejdsgange og ansvarsforhold ved oprettelse og administration af repositories er endnu ikke beskrevet her. Kontakt OS2-sekretariatet, hvis du har brug for hjælp.

Husk README-filen

Alle OS2-produkter og -projekter skal have en README i både deres repository på GitHub og det offentlige filarkiv i Nextcloud.

README-filen på GitHub skal hjælpe andre med at forstå indholdet og finde relevant dokumentation – også når den ligger andre steder.

En README kan være kort eller omfattende. Det vigtigste er, at den skaber overblik.

Du finder forklaring og skabeloner under Organiser dokumentationen i sidemenuen.