provide the repository metadata in CodeMeta and CFF formats

[only1chunts]

User story

As a developer I want to follow good open access community guidelines and behaviours So that we can promote ourselves as a open software producer

Acceptance criteria

Given the repository is open When someone visits it Then they can find a CodeMeta.json file describing the basic required metadata about the tool

Given the repository is open When someone visits it Then can can see a CITATION.cff file describing the basic required metadata about the tool And then can see a "Cite this repository" button on the github page

Additional Info

The Codemeta.json file can be written manually, or the GUI generator tool can be used: https://codemeta.github.io/codemeta-generator/

The resultant json file then just goes in the repo, and should be updated when major changes/releases of the code are made.

This is going to become one of the tools that will enable one to demonstrate you are producing a "FAIR software" object.

Product Backlog Item Ready Checklist

• [ ] Business value is clearly articulated
• [ ] Item is understood enough by the IT team so it can make an informed decision as to whether it can complete this item
• [ ] Dependencies are identified and no external dependencies would block this item from being completed
• [ ] At the time of the scheduled sprint, the IT team has the appropriate composition to complete this item
• [ ] This item is estimated and small enough to comfortably be completed in one sprint
• [ ] Acceptance criteria are clear and testable
• [ ] Performance criteria, if any, are defined and testable
• [ ] The Scrum team understands how to demonstrate this item at the sprint review

Product Backlog Item Done Checklist

• [ ] Item(s) in increment pass all Acceptance Criteria
• [ ] Code is refactored to best practices and coding standards
• [ ] Documentation is updated as needed
• [ ] Data security has not been compromised (with particular reference to the personal information we hold in GigaDB)
• [ ] No deviation from the team technology stack and software architecture has been introduced
• [ ] The product is in a releasable state (i.e. the increment has not broken anything)

[rija]

looks similar to the Citation File Format (CITATION.cff)

[only1chunts]

I asked the CodeMeta people about the similarities with citation.cff, this was their reply:

Citation.cff is for stating the preferred citation(s) of a software repo, while Codemeta is for the software metadata itself. See the terms at https://codemeta.github.io/terms/

While there is some overlap (e.g., authors, license), I would say codemeta's scope is wider. They are complementary, as the referencePublication from CodeMeta could be completed with the information in a CFF file, but CFF represents the citation information in a more machine-friendly manner.

[ScottBGI]

Is it worth integrating the new codeFAIR tool, as its a github plugin that makes it easy for code authors to create CodeMeta files and license files, following the FAIR4RS guidelines? If we don't use it in our submission system we could also manually send them this link in the curators "get data" step if we see code without either of these. See https://codefair.io/