FAIR Compliance Dashboard

[codefair-io]

Check the FAIRness of your software

This issue is your repository's dashboard for all things FAIR. Keep it open as making and keeping software FAIR is a continuous process that evolves along with the software. You can read the documentation to learn more.

README ✔️

A README.md file was found at within your repository.

LICENSE ❗

A custom LICENSE file has been found at the root level of this repository. While using a custom license is normally acceptable for Zenodo, please note that Zenodo's API currently cannot handle custom licenses. If you plan to make a FAIR release, you will be required to select a license from the SPDX license list to ensure proper archival and compliance.

Click the "Edit license" button below to provide a license title or to select a new license.

Metadata ❌

To make your software FAIR, a CITATION.cff and codemeta.json are expected at the root level of your repository. These files are not found in the repository. If you would like Codefair to add these files, click the "Add metadata" button below to go to our interface for providing metadata and generating these files.

FAIR Software Release ❌

To make your software FAIR, it is necessary to archive it in an archival repository like Zenodo every time you make a release. When you are ready to make your next release, click the "Create release" button below to easily create a FAIR release where your metadata files are updated (including with a DOI) before creating a GitHub release and archiving it.

Additional Recommendations

Although these files aren not part of the core FAIR compliance checks, Codefair recommends including them to improve project governance, community engagement, and contributor experience:

CONTRIBUTING.md ✔️

This file helps communicate contribution processes and gives contributors clear guidelines placed at the repo root (or in docs/ or .github/), saving time and reducing rework. It surfaces automatically on pull requests, issues, and the repository's Contribute page to guide contributors at every step.

CODE_OF_CONDUCT.md ✔️

Defines clear standards for respectful engagement and shows a welcoming, inclusive community by outlining expectations and procedures for handling abuse. When placed at the repo root (or in docs/ or .github/), CODE_OF_CONDUCT.md surfaces in the repository's community profile and contributor pages to guide behavior at every step.

_{Last updated Sep 8 2025, 09:23:58 (timezone: America/Los_Angeles)}