Regole di sviluppo

Le regole qui descritte intendono facilitare la collaborazione degli sviluppatori e sono da intendersi come proposta. Se quindi hai commenti o correzioni da proporre non modificare direttamente questa pagina, ma contatta ​SoujaK, che sottoporrà la questione alla squadra di sviluppo.

Sorgenti

La coerenza e l'uniformità del canzoniere sono principi che vanno applicati al canzoniere sia nella sua forma compilata, il documento finale prodotto, sia nella sua forma sorgente, i file di codice LaTeX scritti dagli sviluppatori.

Ogni canzone deve includere testo e accordi del pezzo. Il testo deve essere completo di punteggiatura e maiuscole dopo il punto e nei nomi propri o importanti (es. "Giungla"). Gli accordi sono nel formato italiano (es. "Sol" o "La"); il "minore" si indica con un trattino (es. "Re-"), il "maggiore" con una croce (es. "+"); i mezzitoni sono resi graficamente da songbook: per il "diesis" si usa la gratella (es. "Do#"), per il bemolle una semplice b (es. "Mib").

Deposito

È importante avere delle convenzioni anche sulla gestione del deposito, per facilitarne l'uso condiviso. Il menù "Browse Source" permette una visualizzazione del contenuto del deposito.

Ogni canzone va formattata separatamente in un file TeX con codifica UTF-8. Questo deve essere nominato con il nome della canzone senza articoli, in ​CamelCase e con estensione .song.tex (es. "Il canto della promessa" nel file CantoDellaPromessa.song.tex) e deve poi essere caricato nella cartella di categoria contenuta della cartella "canzoni" del deposito SVN.

Il deposito è organizzato secondo le cartelle trunk, branches e tags, come di consuetudine nell'uso di SVN. Per informazioni su questa pratica, un argomento avanzato dell'uso di SVN, si consiglia la lettura della ​guida alle ramificazioni e fusioni con subversion.

Il ramo trunk è dedicato alla versione stabile del progetto, contenente solo canzoni complete e corrette. Nel caso si desideri sfruttare il sistema di versione anche per canzoni parziali o che necessitino di correzioni si consiglia la pratica della ramificazione, il cosiddetto branching. Qualora si carichino canzoni delle quali non si dispongano gli accordi è necessario aprire un ticket segnalandone la mancanza, in modo che altri possano completare il lavoro.

Di seguito un diagramma dell'organizzazione dei file presenti nel sistema di versione:

• trunk: cartella del progetto stabile
  • canzoni: cartella delle canzoni in formato songbook
    • giungla: canzoni e danze Giungla
    • bosco: canzoni e danze Bosco
    • scout: canzoni Scout
    • messa: canzoni per la Santa Messa
    • altro: canzoni varie progetto
• tags: versioni etichettate del progetto