Scroll to top

A badge for FAIR software


Led by Mateusz Kuzak, Carlos Martinez Ortiz and Jurriaan Spaaks

We want to incentivise research software engineers and researchers who develop software to implement the simple recommendations for making software more FAIR, by making their effort and compliance more visible to the rest of the word.

Led by Mateusz Kuzak, Carlos Martinez Ortiz and Jurriaan Spaaks

Aim

The success of the open-science movement relies on researchers being more open and transparent in sharing their methods, analyses and data, such that these can be reused, verified and/or reproduced by a wider audience. The Netherlands eScience Center and DANS launched fair-software.eu with five actionable and practical recommendations that help researchers to make their software more FAIR (Findable, Accessible, Interoperable, Reusable). 

We want to incentivise research software engineers and researchers who develop software to implement these FAIR recommendations, by making their effort and compliance with the fair-software.eu recommendations more visible to the rest of the world. We also want to promote the recommendations to a wider audience. 

Work at the Sprint

Shields badges are a common way to visualise and communicate the status of the software repository. They can easily be included in GitHub READMEs or other web pages. The service supports dozens of continuous integration services, package registries, distributions, app stores, social networks, code coverage services, and code analysis services. We want to implement a Shields badge that will reflect the compliance with the five FAIR-software recommendations, with the goal of increasing visibility for software authors’ FAIR efforts and encouraging curious visitors to learn more about the recommendations.

During the Sprint, we plan to: 

  1. Design the shield.io badge, with versions from 0/5 to 5/5 recommendations implemented 
  2. Design a way to programmatically measure compliance (whenever possible)
  3. Implement the automated measurement 
  4. Implement GitHub action that will run the measurements and update the badge based on the results 

We are looking for…

Contributors with skills in design to help us design the badge. Familiarity with sheilds.io, its gh-badges library used to generate badges and javascript, and/or familiarity with GitHub actions and continuous integration will be extremely helpful too.