To enable this checker, add the following snippet as .github/workflows/fair-software.yml in your GitHub repository.

name: fair-software

on: push

jobs:
  verify:
    name: "fair-software"
    runs-on: ubuntu-latest
    steps:
      - uses: fair-software/badge@master
        name: Measure compliance with fair-software.eu recommendations
        env:
          PYCHARM_HOSTED: "Trick colorama into displaying colored output" 
        with:
          MY_REPO_URL: "https://github.com/${{ github.repository }}"

Building the docker image:

# (from project root directory)
docker build -t howfairis .

Running the dockerized howfairis locally:

# (from project root directory)
docker run -ti howfairis https://github.com/owner/repo

This badge describes and visualises the compliance with FAIR Sofatware recommendations as described on fair-software.eu website site. The Netherlands eScience Center and DANS launched fair-software.eu with five actionable and practical recommendations that help researchers to make their software more FAIR (Findable, Accessible, Interoperable, Reusable).

Read more about how to interpret the badge in the fair-badge-explained document.

The badge action does checks on the repository it runs on.

Is this software in a version controlled repository (eg. GitHub or Gitlab)? Is this repository open?

Is there a license file? The license does not have to be OSI approved license, but it has to be one of the standard licenses.

Is this software registered in one or more software registry. You can find an extensive list of registries in the Awesome Research Software Registries

Does the repository contain the description on how to cite the software? This can be done in the form of CITATION.cff file, that uses Citation File Format, or plain CITATION file.

Do the developers of the software use a software quiality checklist?