Contributor Guidelines
Linee Guida di codifica, versionamento e gestione dei Contributi
Ogni contributore accetta e si impegna a rispettare le regole di codifica e scrittura dei contributi, come nel seguito descritte.
Rilascio di contributi software
I contributi software devono essere inseriti da parte del contributore nel repository SCM (Source Control Management) dei progetti SpagoWorld.
Lo sviluppo dei progetti SpagoWorld segue le consuetudini (best practices) utilizzate dalla comunità del software libero/open source. Ne consegue che il codice dei progetti SpagoWorld deve essere coerente con le codifiche standard in uso nell'ambiente Java.
In tutti i nuovi file devono essere presenti gli opportuni commenti secondo il formalismo javadoc.
La licenza presente nell'ultima versione consolidata di ogni progetto SpagoWorld deve essere inserita senza modifiche all'inizio di ogni nuovo file sorgente.
In ogni nuovo file sorgente deve essere presente sia il nome dell'autore (colui che ha creato il file), secondo il formalismo javadoc, sia il suo indirizzo e-mail.
Qualora il contributo riguardi del software fornito da un Developer (uno sviluppatore che fornisce contributi al codice o alla documentazione ma che non è ancora diventato contributore) l'autore sarà il Developer stesso, mentre verrà aggiunto un "@contributor tag" per indicare il nome di chi ha consolidato il contributo. In questa evenienza, il contributore si impegna ad inviare al Developer una comunicazione a mezzo e-mail di avvenuta integrazione del software.
Per qualunque file inserito nel repository SCM dei progetti SpagoWorld da parte di un contributore deve essere utilizzato il campo "note" per introdurre gli opportuni commenti alle modifiche.
Engineering si riserva il diritto di attivare una procedura di firma elettronica per il riconoscimento digitale dei contributi, basata su scambio di certificati e di password. In questa evenienza, il contributore accetta di uniformarsi a tale procedura, come verrà comunicata da Engineering, e sarà responsabile della sicurezza della propria autenticazione. Egli sarà ritenuto responsabile per i contributi immessi ed a lui attribuibili in virtù del proprio certificato e della propria password. A tale scopo il contributore si impegna a custodire con la massima riservatezza e diligenza il proprio certificato e a non divulgare a terzi la propria password. Sarà inoltre ritenuto responsabile di qualsiasi danno e conseguenza pregiudizievole arrecata ad Engineering o a terzi a causa di tale inadempienza.
Rilascio di contributi di documentazione
I contributi di documentazione devono essere inviati da parte del contributore a mezzo di posta elettronica tramite la Contributors List di Progetto.
Ogni file di documentazione contiene una sezione con la storia delle modifiche. In essa, accanto alla descrizione delle modifiche, deve comparire il nome dell'autore solo se questo non compare già tra gli autori originali del documento, indicati nel frontespizio.