Issues
Det här lär du dig
Section titled “Det här lär du dig”- Vad en issue är.
- Att skriva en issue som andra förstår.
- Att kommentera och stänga en issue.
Varför behövs det här?
Section titled “Varför behövs det här?”När flera arbetar i samma projekt behövs ett ställe där man kommer överens om vad som ska göras, innan någon börjar. Annars gör två personer samma sak, eller något som ingen ville ha. En issue samlar beskrivningen och diskussionen, och sparar dem efteråt, så att man kan se varför något gjordes.
Så hänger det ihop
Section titled “Så hänger det ihop”En issue (ungefär ärende eller fråga) är en beskrivning av ett fel som ska rättas eller en idé som ska
göras. Varje issue i ett repositoryRepository (repo)En projektmapp som Git håller ordning på: alla filer i projektet plus hela historiken av sparade versioner.Läs mer om repository får ett nummer: #1, #2 och så vidare. Numret
använder du för att hänvisa till den, till exempel i en pull request.
En issue har:
- en titel, som kort säger vad det gäller
- en beskrivning, med det som behövs för att förstå och göra uppgiften
- kommentarer, där man diskuterar
- ett läge: öppen eller stängd
En issue innehåller ingen kod. Den beskriver bara vad som ska göras.
Exempel
Section titled “Exempel”| Mindre bra | Bättre |
|---|---|
Titel: resplan |
Titel: Lägg till en dag i Gävle |
Beskrivning: fixa |
Beskrivning: Vi har en dag över mellan Uppsala och Sundsvall. Gävle ligger på vägen. Lägg till Gävle som dag 3. |
En bra issue säger vad som ska göras och varför. Är det ett fel: vad hände, och vad borde ha hänt?
Övning
Section titled “Övning”Vanliga problem
Section titled “Vanliga problem”Testa dig själv
Section titled “Testa dig själv”Sammanfattning
Section titled “Sammanfattning”- En issue beskriver ett fel eller en idé, och samlar diskussionen om den.
- Varje issue har ett nummer, som
#1. Det används för att hänvisa till den. - En bra issue säger vad som ska göras och varför.
- En issue innehåller ingen kod. Koden kommer i en pull request.