Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Software quality checklist evaluation for 5/5 FAIR score #131

Open
sadielbartholomew opened this issue Mar 31, 2021 · 0 comments
Open

Software quality checklist evaluation for 5/5 FAIR score #131

sadielbartholomew opened this issue Mar 31, 2021 · 0 comments

Comments

@sadielbartholomew
Copy link
Member

sadielbartholomew commented Mar 31, 2021

FAIR data principles are of late being applied to software and some groups have recently created a list of five 'recommendations' to aim for with open (scientific) software, as described on a dedicated site. I've just used a nice CLI tool they have made to detemine how many of the five criteria are met by our repos, and cfdm gets four:

$ howfairis https://github.com/NCAS-CMS/cfdm
Checking compliance with fair-software.eu...
url: https://github.com/NCAS-CMS/cfdm
(1/5) repository
      ✓ has_open_repository
(2/5) license
      ✓ has_license
(3/5) registry
      × has_ascl_badge
      × has_bintray_badge
      ✓ has_conda_badge
      × has_cran_badge
      × has_crates_badge
      × has_maven_badge
      × has_npm_badge
      ✓ has_pypi_badge
      × has_rsd_badge
      × is_on_github_marketplace
(4/5) citation
      × has_citation_file
      × has_citationcff_file
      ✓ has_codemeta_file
      × has_zenodo_badge
      × has_zenodo_metadata_file
(5/5) checklist
      × has_core_infrastructures_badge

Calculated compliance: ● ● ● ● ○

Expected badge is equal to the actual badge. It's all good.

(I also added a badge to the README as they recommend, to showcase our good score and commitment to FAIRness.)

We should aim to satisfy the remaining item in the near future, towards full compliance and a 5/5/ score, namely to "Use a software quality checklist" in a critical and reflective way, with details provided on this page of their site. From the information there, it looks like it could be quite quick and simple to do.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant