Copyright and Attribution

In order to assure standard application of licensing and attribution of contributions, the following standards shall be use:

Source Code

At the beginning of each source code file, the following commented header must be added:

Copyright Header

/**
 * Copyright (C) 2012 TLabs Foundry

    This program is free software: you can redistribute it and/or modify
    it under the terms of the Eclipse Public License v1 as published by
    the Eclipse Foundation.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    Eclipse Public License for more details.

    You should have received a copy of the Eclipse Public License
    along with this program.  If not, see 
    <http://www.opensource.org/licenses/eclipse-1.0>.
 */

JavaDoc and Author Information

To ensure that stanard documenation of the authors and contributors, please use the following format just above the class declaration:

/**
 * This is a description of this classes ability
 * 
 * @author Creator: Original Author - Email Address
 * @author Contributor: First Contributor's Name - Email Address
 * ...
 * @author Contributor: Newest Contributor's Name - Email Address
 * @version Version Number
 *
 */
public class ServerMetadata

Maven POM Files

It is very important that the POM files are documented correctly and in a consitent manner. This becomes especially true as projects are released to the Maven repositories and ensures that correct attribution is distributed:

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <groupId>com.trimda</groupId>
  <artifactId>PROJECT_NAME</artifactId>
  <version>VERSION_NUMBER</version>
  <name>PROJECT_LONG_NAME</name>
  <url>URL_TO_THE_WIKI_PAGE</url>
  <description>VERBOSE_DESCRIPTION_OF_THE_PROJECT</description>
  <inceptionYear>YEAR_THE_PROJECT_BEGAN</inceptionYear>
  <properties>
      <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
      <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
  </properties>
  <organization>
      <name>TLabs Foundry</name>
      <url>https://tlabsfoundry.atlassian.net/wiki/display/TF</url>
  </organization>
  <scm>
      <url>URL_TO_THE_SVN_REPO</url>
  </scm>
  <issueManagement>
      <system>JIRA</system>
      <url>URL_TO_THE_JIRA_INSTANCE</url>
  </issueManagement>
  <!-- USE THE BELOW FOR ANY PROJECT LEADS OR CORE DEVELOPERS ON A PROJECT -->
  q<developers>
    <developer>
      <id>TWO_OR_THREE_LETTER_IDENTIFYER</id>
      <name>DEVELOPERS_NAME</name>
      <email>DEVELOPERS_EMAIL_ADDRESS</email>
      <organization>DEVELOPERS_ORGANIZATION</organization>
      <roles>
        <role>ROLE</role>
      </roles>
    </developer>
  </developers>
  <!-- USE THE BELOW FOR ALL CONTRIBUTORS ON A PROJECT -->
  <contributors>  
    <contributor>
      <id>
      <name>CONTRIBUTOR_NAME</name>
      <email>CONTRIBUTOR_EMAIL_ADDRESS</email>
      <organization>CONTRIBUTOR_ORGANIZATION</organization>
    </contributor>
  </contributors>
</project>