Metadata Schema for Open Source Software

The metadata schema for Open Source Software.

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.

• name Mandatory [array]

  Project Name

  Add the name of the open source software

  • English project name Mandatory [string]
  • French project name Mandatory [string]
• 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]
• homepageURL Mandatory [array]

  Homepage URL

  Add the URL of the project homepage.

  • English homepage URL Mandatory [string]
  • French homepage URL Mandatory [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]
• administrations Mandatory [array]

  Software administrations descriptions

  • 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.

  • uses Mandatory [array]

    Informations about software users.

    • 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]
    • 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.

      • phone [string]

        Phone

        The phone of the contact for the project