ardc-fair-checklist / ardc-fair-checklist.github.io

Self-assessment checklist for FAIR software
https://fairsoftwarechecklist.net
Apache License 2.0
1 stars 1 forks source link

How to limit what item is being described with the checklist #52

Closed jspaaks closed 1 year ago

jspaaks commented 1 year ago

During the initial testing, the reviewers and I had some trouble determining what exactly was the item being described. For example, a given software package may have:

  1. a GitHub repository
  2. GitHub's API
  3. GitHub releases page with versions
  4. archived snapshots of GitHub releases on Zenodo
  5. Zenodo's API
  6. published package on a website like PyPI
  7. PyPI's API

When going through the checklist, are you supposed to treat all of these as one?

Perhaps the answer is, only under certain conditions can you include data from all these sources, e.g. when

Curious to hear your thoughts @tom-h

jspaaks commented 1 year ago

I went with a simpler approach, which is now described in the preamble. Basically it boils down to "a specific copy of a specific version of your software-as-a-concept". IMO this avoids a lot of the confusing language one would otherwise be force to use.