FAIR Compliance Dashboard

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 LICENSE file is found at the root level of the repository.

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 first 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 on Zenodo.

Additional Recommendations

Although these files are 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 14 2026, 15:08:25 (timezone: America/Los_Angeles)
PLEASE NOTE: deleting this issue will require reinstalling the Codefair GitHub App, but closing the issue will allow you to restore the FAIR Compliance Dashboard by reopening the issue.}

Start with the Codefair dashboard documentation linked in the issue, then use the Metadata and Create Release buttons to review the required steps. Done means CITATION.cff and codemeta.json exist at the repository root and a FAIR release is archived through Zenodo.