Skolelinux – retningslinjer for SVN

SVN lagrer alle prosjektfilene og alle endringer som er blitt gjort på dem. Mulighetene er endeløse: Vi kan vise endringer, omgjøre endringer, hente prosjektfiler fra en bestemt dato og mye mer.
SVN lar mange utviklere jobbe sammen på det samme prosjektet og til og med på samme fil til samme tid.
SVN forteller:
- Hva ble endret
- Når endringen ble gjort,
- Hvem endret det og
- Hvorfor ble det endret.

Unngå konflikter ved å kjøre svn update ofte. Jo lengre tid det tar før du oppdaterer jo vanskeligere blir det for SVN å flette inn dine endringer i de endringene andre har gjort.

Ikke start på noe stort uten å fortelle det til noen. Det er irriterende å oppdage at både du og en annen har jobbet hele dagen med presis samme oppgave.

Alle endringer i SVN kan omgjøres. Men hvis du melder inn ødelagt kode og den sprer seg automatisk til hundrevis av Skolelinux-tjenere, i drift så har vi et problem.
Kjør alltid svn update før du melder inn. Dermed forvisser du deg om at fila er oppdatert. I motsatt fall risikerer du å skrive over endringer en annen har gjort i mellomtiden.
Med svn status kan du forsikre deg om at du melder inn rett fil. Denne kommandoen gir deg beskjed om hvilke svn-filer som er endret på din maskin.
Du kan se endringene dine med svn diff før du melder inn. Dette er spesielt viktig med kode som er i produksjon og kan bli kopiert automatisk APT-kilden eller hovednettsida.
Hvis du ikke forstår koden eller oversettelsen, spør andre på IRC eller bruk e-postlistene.
Vurder om du vil lage en arbeidskopi (ny grein) hvis du jobber med kritisk kode.

Meld inn hver gang du frykter å miste arbeide.
Meld alltid inn når du er ferdig, ikke vent til neste dag.
Hvis flere jobber med den samme fila, unngå konflikter ved å melde inn endringene ofte..

Ikke bland endringer som ikke har noe med hverandre å gjøre i samme logg-melding
Adskilte logg-meldinger gjør dem lettere å forstå og man kan lettere gjøre om en bestemt endring.
Hvis en og samme rettelse inkluderer flere filer, så meld inn alle filene under ett.

Pass på å få med hvorfor du endret. (SVN registrerer selv hvem som endret hva og når endringen ble foretatt.)
Skriv loggmeldinga på engelsk med mindre du jobber på et lokalt prosjekt som for eksempel norske nettsider eller oversettelse.
Hvis endringen er uhyre liten, prøv allikevel å finne på noe som kan passe allikevel. Korte beskjeder som f.eks. «Språkvask» eller «Formatendring» er helt i orden hvis det er alt du har gjort.

Eksempler:

Dårlig logg-melding	Bedre loggmelding
asdfff	Reparerte lapp #123 ved å endre magik() til magic().
oppdatert	Oppdaterte magic() med ny endringsmagi.
Mere lagt til i pci.lst	La til PCI ID-er for nye Intel network-kort.