FAIR Compliance Dashboard

Aperta
  • Qualcosa non va?
#1 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
1/5
Tempo stimato
Meno di un'ora
Idoneità per principianti
20/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Attiva
Stack tecnologico
github
Ambito
documentation

Direzione di ricerca

This issue is an automated FAIR compliance dashboard that reports repository files and links to Codefair actions. Start with the linked dashboard documentation to understand its purpose; the payload names no source files or tests. There is no code change specified, and closing the issue can restore the dashboard if needed.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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.

Edit README

LICENSE ❗

Your LICENSE file needs verification. This can happen when:

  • Your license content was modified and we need you to confirm the license type
  • You're using a license that GitHub doesn't recognize but may still be a valid SPDX license
  • You're using a truly custom license

[!NOTE]
If you plan to archive on Zenodo, you'll need to select a license from the SPDX license list. Custom licenses are not currently supported by Zenodo's API.

Click the "Edit license" button below to confirm your license type (select from the dropdown and choose "Keep existing content") or provide a custom license title.

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.

Metadata

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.

Create Release 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.

CONTRIBUTING.md

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.

CODE_OF_CONDUCT.md

Last updated Nov 2 2026, 10:42:10 (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.

Lingua principale
Nessun dato sulla lingua
Stelle
0
Fork
0
Merge medio
1g 1h
PR unite (30g)
4

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Issue simili

Altre issue su Documentation

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.