Contributor Guidelines
Programming, versioning and contribution management guidelines
The contributor agrees and commits himself/herself to respecting 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).
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 latest 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/her e-mail address.
When a developer submits his/her contribution (a developer sends 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 commits himself/herself to send an e-mail to the developer notifying the integration of the contribution.
The contributor must use the "note" field of the SpagoWorld Project SCM repository, inserting the suitable update description when s/he provides it with a new file.
Engineering can start a new digital signature procedure, by its exclusive right, by means of a digital certificate and password exchange aimimg at a digital contributor's identification. In this case, the contributor agrees to use this procedure, which will be notified by Engineering. The contributor will be responsible for the contributions of his/her competence, following his/her digital certificate and password. S/he will be responsible for his/her authentication security as well. Therefore, the contributor commits himself/herself to keeping his/her digital certificate with a high level of security and not to disclose his/her password. S/he will be also responsible for every consequent damage and harm caused to Engineering or any third-party.
Documents Contribution
The contributor must send his/her documentation via e-mail by means of the Project Contributors List.
Every document contains a history section. It contains the description of the changes and the author's name, only in case his/her name doesn't appear in the list of the original authors of the document, on the document front-page.
