Skip to content

docs: add a badge block and link the README title to the docs site - #30

Merged
tschm merged 1 commit into
mainfrom
readme_badges
Aug 7, 2026
Merged

docs: add a badge block and link the README title to the docs site#30
tschm merged 1 commit into
mainfrom
readme_badges

Conversation

@tschm

@tschm tschm commented Aug 7, 2026

Copy link
Copy Markdown
Member

Adds a badge block to the README, modelled on
jebel-quant/jquantstats and adapted
to this repo.

Badges

PyPI version · MIT licence · Python 3.11–3.14 · CI · Coverage · ruff · uv ·
CodeFactor · OpenSSF Scorecard · rhiza template ref · PyPI downloads · Paper

Every endpoint was probed for a 200 before being added, so none of them render
as a broken image. That mattered most for the ones that are specific to this repo
and could not simply be copied from the inspiration:

Badge Verified target
Coverage jebel-quant.github.io/quadprog/coverage-badge.svgreports/html-coverage/
PyPI the cvx-quadprog project, not quadprog
Paper quadprog.pdf on the paper branch, published by rhiza_paper.yml
Rhiza $.ref read live out of .rhiza/template.yml

CodeFactor was initially left out — the repo returned 404 there and a badge
pointing at an unregistered project is worse than no badge. It has since been
registered and now returns 200, so it is included.

The mutation badge is deliberately not here. rhiza_mutation.yml is the
workflow that would publish one, and it stays skipped in this repo (see the
comment at the top of .github/workflows/mutation.yml); the repo-owned mutation
job gates on a survivor baseline instead and publishes nothing to Pages.

H1

Same treatment as the inspiration — linked name plus a tagline:

# [cvx-quadprog](https://jebel-quant.github.io/quadprog): Goldfarb/Idnani QP in NumPy and SciPy

The tagline is a trimmed form of the description in pyproject.toml, so the
headline and the package metadata say the same thing rather than drifting apart.
The docs site is already declared at mkdocs.yml:6.

Verification

  • make fmt — all 21 hooks pass, markdownlint included (MD013 is disabled, so the
    long badge lines are fine)
  • make rhiza-test — 39 passed, 1 skipped; this is the suite that validates the
    README's bash fragments and Python blocks

Docs only — no source, test or config changes.

🤖 Generated with Claude Code

Modelled on jebel-quant/jquantstats, adapted to this repo: PyPI version,
MIT licence, the four supported Python versions, CI, coverage, ruff, uv,
CodeFactor, OpenSSF Scorecard, the rhiza template ref, PyPI downloads and
the paper PDF.

Every endpoint was probed before being added, so none of them render as a
broken image. That includes the three that are specific to this repo and
could not simply be copied across: the coverage badge and HTML report on
Pages, the `cvx-quadprog` project on PyPI, and `quadprog.pdf` on the
`paper` branch.

The H1 gets the same treatment as the inspiration -- linked name plus a
tagline. The tagline is a trimmed form of the `description` in
pyproject.toml, so the headline and the package metadata agree rather
than drifting apart.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Copilot AI lite review requested due to automatic review settings August 7, 2026 10:15

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the project’s top-level README to improve presentation and discoverability by adding a badge block and linking the H1 title to the published documentation site.

Changes:

  • Replace the plain # cvx-quadprog header with a linked H1 that includes a short tagline.
  • Add a set of status/metadata badges (PyPI, license, Python versions, CI, coverage, tooling, etc.) near the top of the README.
Suppressed comments (1)

README.md:16

  • There is an empty line before the Paper badge, which splits it into a new paragraph/row while the other badges are contiguous. If the goal is a single badge block, remove the blank line to keep the layout consistent.
[![Downloads](https://static.pepy.tech/personalized-badge/cvx-quadprog?period=month&units=international_system&left_color=black&right_color=orange&left_text=PyPI%20downloads%20per%20month)](https://pepy.tech/project/cvx-quadprog)

[![Paper](https://img.shields.io/badge/paper-quadprog.pdf-red?logo=adobeacrobatreader)](https://github.com/jebel-quant/quadprog/blob/paper/quadprog.pdf)

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md
Comment on lines +3 to +6
[![PyPI version](https://badge.fury.io/py/cvx-quadprog.svg)](https://pypi.org/project/cvx-quadprog/)

[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)
[![Python versions](https://img.shields.io/badge/Python-3.11%20•%203.12%20•%203.13%20•%203.14-blue?logo=python)](https://www.python.org/)
@tschm
tschm merged commit 5489184 into main Aug 7, 2026
61 checks passed
@tschm
tschm deleted the readme_badges branch August 7, 2026 11:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants