Codefair

Your coding assistant to make research software reusable without breaking a sweat!

Get the app »

Learn more »

Description

Codefair is 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. 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. By communicating with you through GitHub issues and submitting pull requests, Codefair will 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. With Codefair by your side, you're not just developing software but you're advocating for better software practices. Learn more on the app's website codefair.io.

Getting started

Installing

1. Install Codefair from the GitHub market place on the GitHub organizations or repositories of your choice
2. Code as usual
3. Track FAIR compliance issues through the Codefair issue dashboard and address them through the Codefair website.

[!NOTE] While Codefair is free, installing it via the GitHub Marketplace may still require a credit card to be associated with your (or your organization’s) GitHub account. To circumvent this requirement, you can alternatively install Codefair directly from the app page.

Documentation

See our dedicated webpage for full details on what permissions are used and the features Codefair provides.

Run the GitHub app locally

For detailed instructions on setting up running the application locally, please refer to our documentation site.

How Codefair is developed

Codefair is developed using Probot and is deployed on a server 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 a server, 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.

Contributing

Contributions are always welcome!

If you are interested in reporting/fixing issues and contributing directly to the code base, please see CONTRIBUTING.md for more information on what we're looking for and how to get started.

Issues and Feedback

To report any issues with the software, suggest improvements, or request a new feature, please open a new issue via the Issues tab. Alternatively, you can also use our contact form. Provide adequate information (operating system, steps leading to error, etc.) so we can help you efficiently.

License

This work is licensed under MIT. See LICENSE for more information.

How to cite

If you are using this package or reusing the source code from this repository for any purpose, please cite the corresponding Zenodo record. If you are using the latest version, you can see the citation instruction in the GitHub Citation panel or in the CITATION.cff file. You can also find the citation instruction on the Zenodo page https://doi.org/10.5281/zenodo.13376616 (especially if you would like to cite an older version).