What is Codefair?

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).

Info imageInfo image

How does Codefair work?

Simply 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 ensure that your software follows best coding practices, provides metadata in standard formats, 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 designed mainly for biomedical research software. However, most of the steps in the FAIR-BioRS guidelines are applicable to any research software, regardless of the field. This means that anyone developing research software can use Codefair. Whether you are developing artificial intelligence (AI)/machine learning (ML) models with Python, data visualization tools with Jupyter Notebook, or data analysis code with R, Codefair is here to assist you.

How is Codefair developed?

Codefair is developed using Probot and is deployed on our own servers. The GitHub app is configured to receive webhooks for important actions such as pushing code, opening or closing issues, opening or merging pull requests, and commenting on discussions. The app is written in Node.js and utilizes the Octokit library to interact with the GitHub API, enabling seamless integration with GitHub's features and functionality.

With Codefair by your side, you're not just managing repositories but you are advocating for the development of FAIR software

© 2024 - FAIR Data Innovations Hub. All rights reserved.