DataONEorg / object-formats

DataONE Object Formats controlled vocabulary
Apache License 2.0
1 stars 3 forks source link

add CodeMeta format #19

Closed twhiteaker closed 3 years ago

twhiteaker commented 3 years ago

Format Metadata

For 1.0:

For 2.0:

Format description

CodeMeta includes structured metadata about software and may accompany software or scripts in a data package.

Specification / Namespace documentation

https://codemeta.github.io/

Checklist

Considerations

I'm not sure if the format identifier is appropriate, or if some URL should be used such as https://raw.githubusercontent.com/codemeta/codemeta/2.0-rc/codemeta.jsonld.

mbjones commented 3 years ago

Thanks, @twhiteaker, adding CodeMeta would be great. Fully support.

CodeMeta has well-established identifiers for each versioned namespace of the spec (I know, as I created them). So, I suggest each version of codemeta should be registered as a format, as the namespaces (and the field definitions and relationsips) change across the versions. We've had two codemeta releases to date, and expect a third sometime soon.

Also, I think the media type should be application/ld+json: https://www.iana.org/assignments/media-types/application/ld+json

mbjones commented 3 years ago

The namespaces for the two versions of CodeMeta are DOIs. From the CodeMeta site:

I would suggest we use those two namespace URIs for the associated formatId fields, which would allow us to check the two remaining checklist boxes (id is the commony used namespace, and id has embedded version info).

@twhiteaker If you agree with this, can you modify the main proposal above to reflect these changes?

twhiteaker commented 3 years ago

Done

mbjones commented 3 years ago

Looks good to me. I will incorporate it into a PR for review.

mbjones commented 3 years ago

Merged into develop. Closing this issue, please reopen if you see issues to be addressed before the release is made.