Dove devono essere salvati i file di documentazione in SVN?

6

Al momento sto utilizzando un repository per il progetto con la seguente struttura "predefinita":

project
 - trunk
     - docs
 - branches
 - tags

Vorrei sapere se è una buona pratica archiviare i documenti al di fuori della cartella di esempio:

project
 - docs
 - trunk
 - branches
 - tags
    
posta GibboK 10.02.2015 - 15:40
fonte

1 risposta

7

I (dis) vantaggi di avere la documentazione all'interno del baule del repository dipende da una serie di fattori. Alcuni dei più importanti sono:

  • La tua strategia di ramificazione
  • Quanto sono comparabili il ciclo di vita della documentazione e il ciclo di vita del software
  • Il tuo flusso di lavoro per mantenere aggiornata la documentazione e il formato della tua documentazione

Se crei un nuovo tag / ramo per ogni release e la documentazione viene rilasciata in tandem con il codice, mantenere la documentazione all'interno del trunk ha il vantaggio che diventa facile trovare la documentazione che accompagna una particolare release passata, poiché la documentazione viene copiata sul tag / ramo insieme alle fonti.

D'altra parte, se i tuoi documenti vengono rilasciati su un ciclo diverso rispetto al codice (ad esempio, il codice viene taggato e rilasciato quotidianamente, ma la documentazione solo una volta ogni 3 settimane), quindi non vi è alcun vantaggio di avere il documentazione all'interno del trunk, poiché la maggior parte delle versioni del software conterrà quindi documentazione inedita (e probabilmente incompleta).

Come ultima possibilità, se lavori regolarmente su feature branch (e hai l'abitudine di aggiornare la documentazione mentre scrivi il codice), tenere i file di documentazione binaria all'interno del trunk può causare un sacco di problemi di fusione durante l'unione il ramo torna al tronco. Va notato che i formati di file utilizzati dai principali word processor sono tutti binari (XML proprietario o compresso).

    
risposta data 10.02.2015 - 16:23
fonte

Leggi altre domande sui tag