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).
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.
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 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. 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.
codefair is developed using Probot and is deployed on Vercel as a serverless function. 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. By leveraging a serverless environment on Vercel, codefair can automatically scale to handle the workload of the GitHub app. 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.
codefair