seanome/kmerseek

Add status badges of tests, linting, etc

Offen

#12 geöffnet am 06.03.2025

Auf GitHub ansehen
 (0 Kommentare) (0 Reaktionen) (0 zugewiesene Personen)Rust (3 Forks)auto 404
documentationenhancementgood first issue

Repository-Metriken

Stars
 (9 Sterne)
PR-Merge-Metriken
 (Durchschn. Merge 5T 17h) (13 gemergte PRs in 30 T)

Beschreibung

Like the nf-core template (example with seanome/nf-core-kmerseek below), let's add status badges showing the version, linting, tests passing, etc for social proof that our tool is well-maintained.

Contributor Guide

Research-Richtung
Untersuchen Sie das Beispiel von nf core (bereitgestellter Link) und fügen Sie ähnliche Badges zur README.md hinzu. Verwenden Sie shields.io für Badges, die den Teststatus, die Codeabdeckung, das Linting und die Version widerspiegeln. Stellen Sie sicher, dass der CI Workflow (z. B. GitHub Actions) diese Badges generiert.
Tech Stack
rust
Domain
documentationci cd
Issue Type
Dokumentation
SchwierigkeitGeschätzte Implementierungsschwierigkeit für neue Contributors, von 1 für sehr kleine Änderungen bis 5 für Expertenarbeit.
1
Geschätzte ZeitEin grober Zeitrahmen, um zu recherchieren, zu implementieren, zu testen und einen Pull Request vorzubereiten.
Unter 1 Stunde
AktivitätsstatusWie verfügbar das Issue gerade wirkt: frisch, aktiv, stale, blockiert oder wartet auf Maintainer-Input.
Aktiv
KlarheitWie klar das Issue die erwartete Änderung, Akzeptanzkriterien und den nächsten Schritt erklärt.
Klar
Voraussetzungen
Markdown
EinsteigerfreundlichkeitEin Score von 1 bis 100, der schätzt, wie zugänglich dieses Issue für First-Time Contributors ist.
90