Versionshantering och GitHub

Mål

Efter kapitlet ska du kunna...

• förklara varför versioner behövs
• skriva tydliga commit-meddelanden
• ladda upp ett projekt på GitHub
• skriva en enkel README.md

16.1

Vad är versionshantering?

Projektets ändringar sparas som tydliga versioner över tid.

Du kan se vad som ändrades, när det ändrades och varför.

Varför?

En historik som går att förstå

• återgå till en fungerande version
• jämföra ändringar
• samarbeta utan att tappa överblicken
• visa hur projektet utvecklats

Commit

Ett sparat delmål

Varje commit ska samla en begriplig förändring.

Commit-meddelande

Beskriv vad som ändrades

Add function for calculating average

I kursen skriver vi meddelandet på engelska.

Bra mönster

Verb + förändring

• Create first version of the program
• Add menu for user choices
• Fix input error for numbers
• Improve error handling with try-except

För vaga meddelanden

Vad hände egentligen?

Historiken blir nästan oanvändbar om meddelandet saknar innehåll.

Interaktiv kontroll

Granska ett commit-meddelande

Kontrollera meddelandet.

16.2

GitHub lagrar projektet

Ett repository är projektets plats på GitHub.

I kursen kan du skapa och ladda upp via webbläsaren – terminalen behövs inte.

Förbered

Du behöver

• ett GitHub-konto
• ett repository för projektet
• projektets .py-filer
• en README.md

Skapa repository

Projektets behållare

1. Välj New repository.
2. Skriv ett tydligt namn.
3. Välj Public eller Private.
4. Skapa repositoryt.

Ladda upp

Via webbläsaren

1. Välj Add file → Upload files.
2. Välj projektets filer.
3. Skriv ett tydligt commit-meddelande.
4. Välj Commit changes.

Arbetsflöde

Ladda upp ofta

Gärna efter varje arbetspass eller tydligt delmål.

Vad ska med?

Projektets nödvändiga filer

• main.py och andra Python-filer
• README.md
• bilder eller data som programmet behöver

Kontrollera att du laddar upp rätt version av rätt fil.

Vanliga misstag

Undvik luckor i historiken

• fel fil eller gammal version
• vaga commit-meddelanden
• allt laddas upp först när projektet är klart
• en fungerande version skrivs över utan att sparas

16.3

README förklarar projektet

README.md är projektets startsida och skrivs med Markdown.

I kursen skriver vi den på engelska.

Innehåll

Besvara fyra frågor

Exempel

README.md

# Movie Program
This program lets the user register a movie.

## How to run
Run the file main.py in Python.

## Files
main.py - contains the program
README.md - describes the project

## Author
Paul

Sammanfattning

Kom ihåg

• En commit är ett sparat och beskrivet delmål.
• Skriv engelska meddelanden enligt verb + förändring.
• Testa och ladda upp regelbundet.
• README.md förklarar projekt, körning, filer och skapare.