skills.rest
darellchua2
darellchua2COMMUNITY
Explore all skills by this author →
Website𝕏@DarellChua2GitHub

coverage-readme-workflow

Detect Next.js or Python project type, run coverage tests, and update README.md badges and tables.

4|4|Updated Jan 15, 2026
Search Tags:#workflow#documentation#pytest#jest#readme#coverage#badge
One-click install
npx skills add https://github.com/darellchua2/opencode-config-template --skill coverage-readme-workflow
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: coverage-readme-workflow
Source: https://github.com/darellchua2/opencode-config-template/tree/main/skills/coverage-readme-workflow
Command: npx skills add https://github.com/darellchua2/opencode-config-template --skill coverage-readme-workflow

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill ensures test coverage visibility in README.md for Next.js and Python projects by automatically updating badges and coverage tables, reducing manual maintenance and miscommunication of code quality.

Core Features & Use Cases

  • Detects project type (Next.js/JavaScript or Python) and selects the appropriate coverage workflow.
  • Runs tests with coverage, parses results, updates a Shields.io badge, and appends a detailed coverage table in README.md.
  • Keeps documentation in sync with code changes, suitable for PRs, releases, and CI triggers.

Quick Start

To update coverage in a project, run: opencode --agent coverage-readme-workflow "update coverage badge"

Frequently Asked Questions about coverage-readme-workflow

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I automatically update test coverage badges in my README?▼

To automatically update test coverage badges in your README, this skill runs tests with coverage, parses the results, and updates a Shields.io badge along with a detailed coverage table directly in README.md.

How do I generate a coverage table for a Python project using pytest?▼

To generate a coverage table for a Python project, this skill detects the project type, runs tests using pytest-cov, parses the coverage results, and appends a detailed coverage table into README.md.

Can I use this workflow to display Jest coverage in a Next.js README?▼

Yes, you can display Jest coverage in a Next.js README because this workflow supports Jest and Vitest, automatically running tests and updating the README documentation with current coverage metrics.

What is the best way to keep README documentation in sync with code coverage?▼

The best way to keep README documentation in sync with code coverage is to automate the workflow during PRs, releases, or CI triggers to run tests and update the README badge and table automatically.

Does this coverage workflow support both JavaScript and Python projects?▼

Yes, this coverage workflow supports both JavaScript and Python projects by detecting the project type and selecting the appropriate test runner, either Jest/Vitest for Next.js or pytest-cov for Python.

Why is my test coverage badge not updating in README.md?▼

If your test coverage badge is not updating in README.md, you should review the troubleshooting guidance provided by the workflow to ensure tests execute correctly and the README parser updates the Shields.io badge properly.

Related Skills

Explore More Software Engineering Skills→
mehdicmehdic
21

test-coverage

Generate comprehensive test coverage reports for Python, JavaScript, Go & Java projects.

Community
Intermediate
BerryKuipersBerryKuipers
7

validate-coverage-threshold

Validate JavaScript/TypeScript test coverage against configured thresholds from coverage reports.

Community
Intermediate
Mang30Mang30

verification-loop

Run build, type-check, lint, test, and security scans before PR submission.

Community
Intermediate
SocketDevSocketDev
125

fleet-updating-coverage

Run coverage tooling and update the root README coverage badge.

Official
Advanced