seanome/kmerseek

Add status badges of tests, linting, etc

Open

#12 opened on Mar 6, 2025

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Rust (3 forks)auto 404
documentationenhancementgood first issue

Repository metrics

Stars
 (9 stars)
PR merge metrics
 (PR metrics pending)

Description

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 direction
Examine the example from nf core (link provided) and add similar badges to README.md. Use shields.io for badges reflecting test status, code coverage, linting, and version. Ensure the CI workflow (e.g., GitHub Actions) generates these badges.
Tech stack
rust
Domain
documentationci cd
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Markdown
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90