Open Source Code Metadata Schema

Data files are hosted on GitHub.

Version 1.0

Mandatory fields are marked with "mandatory".

We've created an example file with only mandatory fields you can use to get started.

• schemaVersion Mandatory [string]

  ORE metadata schema version

  The version of the ORE metadata schema for open source code. This is currently version 1.0.

• adminCode Mandatory [string]

  Canadian public administration

  Select a public administration from the drop-down field or add a new one in case the administration does not exist.

• releases Mandatory [array]

  Information for each project or source code published.

  • name Mandatory [array]

    Project Name

    Add the name of the project.

    • English name Mandatory [string]
    • French name Mandatory [string]
  • team [array]

    Team

    Add the name of the team, branch or sector within the public administration to which this belongs. For example, the Canadian Digital Services is a sector within the federal administration Treasury Board of Canada Secretariat.

    • English name [string]
    • French name [string]
  • status [string]

    Status

    Select the project development status from the drop-down field according to its current life cycle stage.

  • description Mandatory [array]

    Description

    • whatItDoes Mandatory [array]

      What it does

      Description on what it does

      • English Mandatory [string]
      • French Mandatory [string]
    • howItWorks [array]

      How it works

      Description on how it works

      • English [string]
      • French [string]
  • category Mandatory [string]

    Category

    Select the best fit category for the project. Categories in the drop-down list correspond to the Software Family of the UNSPSC Taxonomy codes.

  • tags Mandatory [array]

    Tags

    Add keywords to help distinguish between various instances.

    • English tags Mandatory [string]
    • French tags Mandatory [string]
  • contact Mandatory [array]

    Contact Information

    • email Mandatory [string]

      Email address

      Email address to contact the project. It should be an email address of where a contact can be directly reached.

    • name [string]

      Name

      The name of a contact for the project.

  • partners[array]

    Key Partners

    • adminCode [string]

      Admin code

      The administration code for the partner.

    • email [string]

      Contact email

      The email address to contact the partner.

    • name [array]

      Administration name

      The name of the contact in the administration partnering on the project.

      • English name [string]
      • French name [string]
  • date Mandatory [string]

    Creation Date

    Select the date when the open source code was first created

  • repositoryUrl Mandatory [array]

    Code Repository URL

    The URL of the public release repository, where the code is hosted.

    • English repository URL Mandatory [string]
    • French repository URL Mandatory [string]
  • homepageURL [array]

    Homepage URL

    Add the URL of the project homepage.

    • English homepage URL [string]
    • French homepage URL [string]
  • downloadUrl [array]

    Download URL

    The URL of the project download page, where a distribution of the project can be found.

    • English download URL [string]
    • French download URL [string]
  • licences Mandatory [array]

    Project Licenses

    • URL Mandatory [array]

      URL

      • English licence URL Mandatory [string]
      • French licence URL Mandatory [string]
    • spdxID Mandatory [string]

      The SPDX License identifier - Search the List of licenses List of licences.

      Search the list of licenses to find the SPDX license identifier according to the project license's name. Add the URLs of the license's repository.

    • level Mandatory [string]

      License level

      License level within the project, if it covers the whole project or only a section

    • scope Mandatory [array]

      Scope of the sub license within the project, only applicable when 'sub license' level is selected

      • English license scope Mandatory [string]
      • French license scope Mandatory [string]
  • languages [array]

    Programming Languages

    Select the programming languages that are used in the project. Add new ones in case the programming languages are not listed.

  • relatedCode [array]

    Related Softwares

    • URL [array]

      URL

      The english and french URLs of related software.

      • English URL [string]
      • French URL [string]
    • name [array]

      Name

      The english and french name of related software.

      • English name [string]
      • French name [string]