Write proposal for the schema.org adoption of the CodeMeta terms

[moranegg]

On Force11's Software Citation Implementation Working Group we have started working on a proposal for the schema.org adoption of the CodeMeta terms:

• softwareSuggestions softwareSuggestions on schema.org #233
• maintainer Add a "maintainer" property, applicable to datasets (and potentially projects, orgs) schemaorg/schemaorg#2311
• contIntegration Link to continuous integration service #243
• buildInstructions Proposal to add buildInstructions in schema.org #245
• developmentStatus developmentStatus - propose the addition of the property into schema.org #244
• embargoDate embargoDate #254
• funding Describe the funding of a person/project/creative work schemaorg/schemaorg#383
• issueTracker Proposal to add issueTracker to schema.org #252
• referencePublication primaryPublication and other publications associated with a Dataset/CreativeWork schemaorg/schemaorg#1763
• readme Proposal to add readme to schema.org #247
• hasSourceCode Proposal to add hasSourceCode property in schema.org #246 (not a CodeMeta term, but was recently discussed here on linking between SoftwareSourceCode and SoftwareApplication? #198)

We will post here our proposal for each term or all terms for community feedback and then post it on the schema.org repository.

You are welcome to see and contribute comments to our working documents:

• Workflow: https://docs.google.com/document/d/1s2mUS9JjIOq-4-0rZTFNaTO7W9umNF4mCf-uypPwGsQ/edit?usp=sharing
• Terms dashboard: https://docs.google.com/spreadsheets/d/1VmUBdgaC7mtj7gDNqTBzPUdosux1R26Cyp7qA7WHkNA/edit?usp=sharing

[dbouquin]

Proposal text for softwareSuggestions:

It is sometimes useful to specify when a software package is helpful, but not required, to run a specific code. For instance, something like the Python module "Palettable" could be used to visualize results and make a graph more accessible to people with visual impairments, but it may not be required to render a graph.

A new property named "optionalDependencies" could be used to make distinctions between true dependencies that are required to run software, and optional dependencies that are just recommended. A property like this could be similar to Wikidata's “software add-on (Q70383937).”

[agbeltran]

@dbouquin Just to add the links to track back the reasons behind the 'softwareSuggestions' property as I could find:

• here there is an example of codemeta using 'softwareSuggestions':

  codemeta/examples/codemeta.json

  Line 43 in 7243575

  "softwareSuggestions": [

• here is the DESCRIPTION file for the R package being described: https://github.com/ropensci/codemetar/blob/master/DESCRIPTION
• and here the R documentation on description: http://r-pkgs.had.co.nz/description.html that describes Suggests as Suggests: your package can use these packages, but doesn’t require them. You might use suggested packages for example datasets, to run tests, build vignettes, or maybe there’s only one function that needs the package.

[dbouquin]

Moved discussion to #233

[moranegg]

Update: maintainer has been added as a property: https://schema.org/maintainer

[mbjones]

That's great, @moranegg . As these are accepted into schema.org, it strikes me that we should be modifying the CodeMeta schema to reference the new schema.org types. So I am going to target this at v3.0 milestone.

[ploewe]

+1

Peter L.