The CodeMeta project defines a standard metadata syntax (schema) specifically design to describe “scientific software and code”.
Currently - although this will probably evolve soon -, it is the suggested metadata schema to be used within the OSSR. To date, the GitLab-Zenodo OSSR environment only works with this schema.
Besides allowing that the GitLab-Zenodo OSSR environment works, including a metadata file to your project will make it FAIR compliant. Thus, the main reason to include a descriptive metadata file into your project.
How to generate a
codemeta.json file ?
The CodeMeta project also provides a CodeMeta generator.
We strongly suggest to provide a metadata file as complete as possible, every metadata entry is important! A more complete and detailed metadata file will facilitate and encourage FAIR the principles.
You can check all the
key:value entries in the ESCAPE metadata template.