README: add curated badge bar (release, license, Python, docs) - #173
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR adds a compact badge row near the top of README.md so repository visitors can immediately see key project metadata without changing the existing status, Binder, DOI, or JOSS sections.
Changes:
- Adds a latest-release badge linked to GitHub Releases.
- Adds license and Python-version badges consistent with current package metadata.
- Adds a documentation badge linked to the existing Read the Docs site.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Adds release, license, Python, and docs status badges in a single top bar — at-a-glance identifiers for new visitors. Excludes commit activity / last-commit type badges (vanity metrics that pressure churn-for-churn's-sake on a maturing scientific codebase). DOI and JOSS badges remain in the References section where their prose context explains how to cite. Underworld development team with AI support from Claude Code
lmoresi
force-pushed
the
feature/readme-badges
branch
from
May 7, 2026 06:25
a8befb1 to
28bd66b
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a four-badge bar at the top of
README.md:These are at-a-glance identifiers for visitors landing on the repo. CI status badges, Binder launchers, DOI, and JOSS badges remain unchanged in their existing sections — DOI and JOSS keep their prose context in References and Archives.
Deliberately excluded: "commits this month", "last commit", and similar activity badges. On a maturing scientific codebase a quiet week doesn't mean what those badges suggest, and they incentivise churn over substance.
Test plan
Underworld development team with AI support from Claude Code