NCAS-CMS / NCAS-CMS/cf-python

Software quality checklist evaluation for 5/5 FAIR score

Aperta
#200 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Lingua principale
Python
Stelle
150
Fork
23
Merge medio
1g 11h
PR unite (30g)
2

Descrizione

See the description in the equivalent issue on cfdm, NCAS-CMS/cfdm#131 for context. In the case of cf-python, the evaluation tool currently reports the following (note I added a small config. file so the tool recognises that cf-pytohn is on Zenodo):

$ howfairis https://github.com/NCAS-CMS/cf-python
Checking compliance with fair-software.eu...
url: https://github.com/NCAS-CMS/cf-python
(1/5) repository
      ✓ has_open_repository
(2/5) license
      ✓ has_license
(3/5) registry
      × has_ascl_badge
      × has_bintray_badge
      ✓ has_conda_badge
      × has_cran_badge
      × has_crates_badge
      × has_maven_badge
      × has_npm_badge
      ✓ has_pypi_badge
      × has_rsd_badge
      × is_on_github_marketplace
(4/5) citation
      ✓ skipped (reason: cf-python is cited on Zenodo and a README badge links to the citation, but that is not picked up by the howfairis compliance checker because the badge in question is a generic website badge linking to the Zenodo page rather than a formal Zenodo badge, purely so the badge colour could be changed to be consistent with our other references.)
(5/5) checklist
      × has_core_infrastructures_badge

Calculated compliance: ● ● ● ● ○

Expected badge is equal to the actual badge. It's all good.

Guida per i contributori

Apri la guida per i contributori

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.

Direzione di ricerca

Inizia leggendo l’issue equivalente NCAS-CMS/cfdm#131 e rieseguendo il comando howfairis mostrato per cf-python. Esamina il file di configurazione aggiunto e i link dei badge nel README, quindi determina quali controlli falliti possono essere risolti; il lavoro è completato quando la valutazione raggiunge il punteggio FAIR previsto di 5/5.

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

Valutazione

Stack tecnologico
python
Ambito
documentation
Tipo di issue
Funzionalità
Difficoltà
4/5
Tempo stimato
3-5 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.