Skolelinux SVN Richtlijnen

Waarom gebruiken we SVN?

• SVN slaat alle project bestanden, en alle veranderingen die eraan gedaan worden op. De mogelijkheden zijn groot: we kunnen veranderingen controleren, ongedaan maken, versies van een bepaalde datum ophalen, en nog veel meer.
• SVN laat toe dat vele ontwikkelaars samen aan een project werken, en zelfs tegelijktertijd in hetzelfde bestand werken.
• SVN vertelt ons:
  • Wat veranderd is;
  • Waneer de verandering doorgevoerd werd;
  • Wie de verandering doorvoerde, en;
  • Waarom de verandering doorgevoerd werd.

Vaak actualizeren

• Om SVN conflicten te vermijden kunt u best regelmatig svn update uitvoeren. Hoe langer u wacht om te aktualizeren, hoe moeilijker het wordt om je veranderingen met de aanpassingen van andere ontwikkelaars samen te voegen.

Communiceer

• Begin niet zomaar aan iets te werken zonder anderen op de hoogte te brengen. Er niks irritanter dan te ontdekken dat iemand anders de hele dag aan hetzelfde ding dubbel werk heeft zitten doen.

Bedenk je tweemaal

• Hoewel alle veranderingen ongedaan gemaakt kunnen worden, is het erg vervelend wanneer fouten naar vele in werking zijnde Skolelinux servers verspreid worden.
• Voer svn update uit voor je 'commit', hierdoor verzeker je je ervan dat het bestand aktueel is. Do je dit niet dan riskeer je om de veranderingen van anderen te overschrijven.
• svn status is een handige manier om er zeker van te zijn dat je de correcte bestanden gaat doorsturen.
• Kijk je veranderingen na met svn diff alvorens ze door te voeren. Dit is erg belangrijk met zogenaamde 'live code', die automatisch naar de APT opslagplaats of the hoofdwebsite wordt gekopieerd.
• Indien je de code niet verstaat, vraag het dan aan andere ontwikkelaars via IRC of de mailinglijst
• Overweeg om een nieuwe tak te openen wanneer je met 'live code' wil experimenteren

Voer je veranderingen vaak door

• Voer telkens wanneer je bang bent je werk te verliezen svn commit uit, om je veranderingen door te voeren naar svn.
• Voer altijd wanneer je klaar bent je veranderingen door, wacht niet tot de volgende dag
• Indien er met meer dan een ontwikkelaar aan hetzelfde bestand gewerkt wordt voer je je veranderingen best vaak door om conflicten te vermijden

Een doelstelling voor elke 'commit'

• Meng geen ongerelateerde aanpassingen in dezelfde 'commit'
• Gescheiden doorvoeren van veranderingen maakt deze makkelijker na te kijken en indien nodig, makkelijker ongedaan te maken.
• Indien een enkele aanpassing meerdere bestanden overspant, 'commit' deze dan allemaal terzelfdertijd.

Schrijf een goede logberichten

• Zorg ervoor dat het waarom van je aanpassingen beschreven is. (SVN weet zelf al wie, wat, wanneer verandert heeft)
• Schrijf de logberichten in het Engels, zeker wanneer je niet met vertaling van webpagina's bezig bent
• Probeer zelfs als de verandering triviaal is om iets betekenisvol te zeggen. Korte berichten zoals 'typo' of 'formatting' zijn OK, als dat alles is wat je gedaan hebt
• Voorbeelden:

  Slecht log	Goed log
  asdfff	Fixed bug #123 by renaming magik() to magic().
  updated	Updated magic() with a new transmogrification spell.
  more stuff in pci.lst	Added PCI IDs for recent Intel network cards.