Codefair

Make your research software
reusable without breaking a sweat!

Grey grid
Codefair logo

About

codefair is a free and open source GitHub app that acts as your personal assistant when it comes to making your research software reusable and especially complying with the Findable, Accessible, Interoperable, Reusable (FAIR) Principles for Research Software (FAIR4RS Principles).

What is a research software?

The commonly accepted definition of research software is "Any software created during the research process or for a research purpose". It can come in many format and could be developed for different applications such as artificial intelligence (AI)/machine learning (ML) models with Python, data visualization tools with Jupyter notebook, or data analysis code with R.

What does making a research software FAIR means?

The FAIR (Findable, Accessible, Interoperable, Reusable) Principles for Research Software (FAIR4RS Principles) are a set of high-level instructions established by the research software community to make software reusable. Making research software FAIR means complying with each of the 17 FAIR principles.

How does codefair work?

Just install codefair from the GitHub marketplace on your software’s GitHub repository. By communicating with you through GitHub issues and submitting pull requests, codefair will then make sure that your software follows best coding practices, provides metadata in standard format, includes a license file, is archived on Zenodo, and much more to align with the FAIR4RS principles.

Who should use codefair?

Currently, codefair helps make software FAIR by following the FAIR Biomedical Research software (FAIR-BioRS) guidelines. Therefore it is design mainly for biomedical research software. However, most of the steps of the FAIR-BioRS guidelines are applicable to any research software irrespective of the field of research. Therefore, anyone developing a research software can use codefair.

Development Approach

The codefair application is maintained in a GitHub repository and are developed in an open and transparent manner. We are always open for contributions from the community.

fairshare contributorsfairshare starsfairshare issues

Timeline

April 2024 - Birth of Codefair

The first prototype of Codefair is developed for demo purpose by the FAIR Data Innovations Hub.

Impact

CodeFair

Citation

CodeFair. (2024). https://github.com/fairdataihub/codefair-app