Programming, versioning and contributions management guidelines

The Contributor agrees and commit himself to respect the Contribution coding, writing, versioning and management guidelines, as follows.

Software Contribution

The Contributor must release his/her Contribution in the specific SpagoWorld Project SCM repository (Source Control Management).

The SpagoWorld Projects use the best practices available in the free software/open source community. Therefore, SpagoWorld source code must follow the usual Java coding standard.

The Contributor must insert the suitable javadoc comments in every new file.

The Contributor must insert the license description of the last distributed SpagoWorld project version in the starting section of every new source file.

Every new source file must contain both author's name (who created the file), following the javadoc format, and his/hers e-mail address.

When a Developer will submit the Contribution (a developer send a source code or documentation Contribution via e-mail, but it is not a Contributor yet), the author's name in the source file will be the Developer's one. Also a "@contributor tag" will be inserted indicating the Contributor's name. When this event occurs, the Contributor commit himself to send an e-mail to the Developer notifying the Contribution.

The Contributor must use the "note" field of the SpagoWorld Project SCM repository inserting the suitable update description when he/she inserts every new file.

Engineering can start a new digital signature procedure, by its exclusive right, by means of a digital certificate and password exchange, whit the aim of a digital Contributor's identification. In this event, the Contributor agree to use this procedure; it will be notified by Engineering. The Contributor will be responsible of the Contributions of his/her competence following his/her digital certificate and password. He/she will be responsible for his/her authentication security; for this aim, the Contributor commit himself/herself to keep his/her digital certificate with a high level of security and not to disclose his/her password; he/she will be also responsible of every damage and harmful consequence caused to Engineering or any third-party following this default.

Document Contribution

The Contributor must send documentation via e-mail by means of the Project Contributors List.

Every document contains a history section. It contains the update description and the author's name when he/she is not one of the document's owner, as written in the document's front-page