Show where OpenBot stands on Trendshift - #396
Open
jerelvelarde wants to merge 1 commit into
Open
Conversation
jerelvelarde
requested review from
MikeRyanDev,
davidmckayv,
guidovizoso and
tylerslaton
as code owners
September 6, 2026 03:06
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.
The problem
OpenBot has been on Trendshift's daily list since 20 August, and it is currently sitting in the top
three repositories of the day. A reader arriving at the README has no way to know that. The header
carries four badges, and every one of them is about the machinery: CI is green, the security workflow
is green, the licence is MIT, the status is alpha. All four are things a maintainer needs. None of
them is a reason for a stranger to keep reading.
That gap matters more for an alpha than it would for a settled project. The README opens by admitting
rough edges and active development, which is honest and also a reason to bounce. The thing that
earns a second look from somebody who has never heard of this repository is that other people are
already looking, and right now the README says nothing about that at all.
The approach
One badge, added to the centred header block between the navigation line and the existing badge row.
The badge is live rather than a written-down number. Trendshift serves the rank as an SVG that it
re-renders, so the README reflects the current standing without anybody editing it again. A hardcoded
"#2" would be wrong within a day and would stay wrong until somebody noticed. This is the whole reason
the change is two lines and not a recurring chore.
It sits on its own line, above the small badges, rather than joining the row. The Trendshift badge
is 250x55 against roughly 20px for a shields.io badge. Dropped into the same row it would tower over
its neighbours and force a ragged wrap. On its own line the size reads as deliberate, and the
machinery badges stay grouped as a set.
It is an
<img>tag with explicitwidthandheight, not markdown image syntax. GitHub proxiesthe SVG through camo, and without the dimensions the badge renders at whatever intrinsic size camo
reports, which is not reliably the 250x55 the artwork is drawn for. The rest of the header uses
markdown badge syntax; this one line does not, and the inconsistency buys a stable render.
The URL is
/api/badge/trendshift/repositories/175080/daily. The shorter/api/badge/repositories/175080form, which Trendshift's own embed dialog hands out, returns a 500and would render as a broken image in the header of the README. I verified both by hand before
choosing.
The cost is worth naming: the header now depends on a third party staying up. If Trendshift goes
down or drops the endpoint, the first thing under the navigation line is a broken image, in the most
visible place in the repository. The four existing badges already carry that exposure to
github.com and shields.io, so this is one more host rather than a new kind of risk, but it is a real
one and it is the reason to keep the badge count from growing further.
What is not covered
trended on, and that standing is not surfaced anywhere.
whatever they decide the badge should look like next.
building this. It moves on its own; the point of the change is that the README moves with it.
not disappear on a dark theme, but it does sit as a light rectangle against a dark page.
mainhas diverged from this branch's base and does not pick the badge up until itnext syncs from here.
Verification
Documentation only, two added lines in
README.md, no code and no new tests. The baseline suite isuntouched by this branch, so I did not run it.
What I checked instead, by hand:
GET /api/badge/trendshift/repositories/175080/dailyreturns200 image/svg+xml, 3691 bytes, withan
aria-labelof "Trendshift: number 3 repository of the day".GET /api/badge/repositories/175080returns500with an empty body, which is why that form is notthe one in the diff.
this branch's
README.md, not a mockup, so the badge placement and wrap are the real ones.