Page tree
Skip to end of metadata
Go to start of metadata

Guidelines

Nordix license headers must be used on code and documentation being submitted to Nordix and through Nordix to other open source projects. The license headers for various types of source and documentation files are stored in the licenses directory of the infra/tools repo in the Nordix gerrit.

In the example files, the copyright line is specified as follows:

Copyright (C) 20XX-20YY Nordix Foundation.

Where XX is the year of the creation of the file and YY  is the year of the last modification of the file. Modify the XX and YY  dates as appropriate.

In cases where creation and all modifications occurred in the same year, modify the line above as follows:

Copyright (C) 20XX Nordix Foundation.

Where XX is the year of the creation of the file.

Never change the Copyright notice of another company on a file.

In cases where a substantial change is made to an existing file originally authored by another company or organization, add a Nordix copyright line under the copyright line or lines already in the copyright notice:

Copyright (C) 2014-2016 Acme Corporation.
Modifications Copyright (C) 2017 Snake Oil Inc.
Modifications Copyright (C) 20XX Nordix Foundation.

A "substantial change" is where the code change goes beyond formatting or minor bug fixing.

Code Licenses

  • java-license.txt: Use for Java oriented source code files such as:

    • java (.java)

    • javascript *.javascript, .js)

    • css (.css)

    • mvel (.mvel)

    • string templates (.st)

  • xml-license.txt: Use for XML and similar tagged source files such as:

    • XML (.xml)

    • HTML (.html)

    • XSD XML Schema (.xsd)

    • XJB JAXB Bindings (.xjb)

    • MarkDown (.md)
  • shell-license.txt: Use for Shell/Bash scripts and other scripts that use a # character for comments

    • Shell and bash scripts (.sh)

    • Python (.py)

    • Jython (.jython)

    • JRuby (.jruby)

    • Ruby (.ruby)

    • Docker files (Docker)

    • Apex scripts (.apex)

    • Yaml files (.yaml, .yml)

    • SQL command scripts (.sql)

  • windows_bat-license.txt: For Windows batch files

    • Windows batch files (.bat)

  • plain_code-license.txt: For other code that uses another delimiter type for comments, please adapt this file and check in an example license file here.

Documentation Licenses

  • adoc-license.txt: For asciidoc documentation source files.

  • rst-license.txt: For rst (restructured text) documents, the official ONAP documentation format.

  • plain_doc-license.txt: For other documentation that uses another delimiter type for comments, please adapt this file and check in an example license file here.

  • No labels